logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

calico.1 (2033B)

    

  1. .Dd August 27, 2020
  2. .Dt CALICO 1
  3. .Os
  4. .
  5. .Sh NAME
  6. .Nm calico
  7. .Nd dispatches cat
  8. .
  9. .Sh SYNOPSIS
  10. .Nm
  11. .Op Fl H Ar host
  12. .Op Fl P Ar port
  13. .Op Fl t Ar timeout
  14. .Ar directory
  15. .
  16. .Sh DESCRIPTION
  17. The
  18. .Nm
  19. program
  20. dispatches incoming TLS connections
  21. to instances of
  22. .Xr pounce 1
  23. by Server Name Indication (SNI).
  24. Instances of
  25. .Xr pounce 1
  26. should be configured with
  27. .Fl U
  28. to bind to UNIX-domain sockets
  29. in the directory passed to
  30. .Nm .
  31. .
  32. .Pp
  33. Note that
  34. .Nm
  35. is not a proxy.
  36. Incoming connections are passed directly
  37. to instances of
  38. .Xr pounce 1 ,
  39. which handle TLS negotiation.
  40. Instances of
  41. .Xr pounce 1
  42. and
  43. .Nm
  44. can be restarted
  45. independently of each other.
  46. .
  47. .Pp
  48. The arguments are as follows:
  49. .Bl -tag -width Ds
  50. .It Fl H Ar host
  51. Bind to
  52. .Ar host .
  53. The default host is localhost.
  54. .It Fl P Ar port
  55. Bind to
  56. .Ar port .
  57. The default port is 6697.
  58. .It Fl t Ar timeout
  59. Set the timeout in milliseconds
  60. after which a connection will be closed
  61. if it has not sent the ClientHello message.
  62. The default timeout is 1000 milliseconds.
  63. .It Ar directory
  64. The path to the directory containing
  65. .Xr pounce 1
  66. UNIX-domain sockets.
  67. .El
  68. .
  69. .Sh EXAMPLES
  70. Start and dispatch to two instances of
  71. .Xr pounce 1 :
  72. .Bd -literal -offset indent
  73. $ pounce -U /var/run/calico -H oftc.example.org oftc.conf
  74. $ pounce -U /var/run/calico -H libera.example.org libera.conf
  75. $ calico -H example.org /var/run/calico
  76. .Ed
  77. .Pp
  78. The two instances can be connected to via
  79. .Li oftc.example.org:6697
  80. and
  81. .Li libera.example.org:6697 ,
  82. respectively.
  83. .
  84. .Sh SEE ALSO
  85. .Xr pounce 1
  86. .
  87. .Sh STANDARDS
  88. .Bl -item
  89. .It
  90. .Rs
  91. .%A D. Eastlake 3rd
  92. .%T Transport Layer Security (TLS) Extensions: Extension Definitions
  93. .%I IETF
  94. .%R RFC 6066
  95. .%U https://tools.ietf.org/html/rfc6066
  96. .%D January 2011
  97. .Re
  98. .It
  99. .Rs
  100. .%A E. Rescorla
  101. .%T The Transport Layer Security (TLS) Protocol Version 1.3
  102. .%I IETF
  103. .%R RFC 8446
  104. .%U https://tools.ietf.org/html/rfc8446
  105. .%D August 2018
  106. .Re
  107. .El
  108. .
  109. .Sh AUTHORS
  110. .An June Bug Aq Mt june@causal.agency
  111. .
  112. .Sh BUGS
  113. Send mail to
  114. .Aq Mt list+pounce@causal.agency
  115. or join
  116. .Li #ascii.town
  117. on
  118. .Li irc.tilde.chat .