kdc/bx509d.8

   1 .\" Copyright (c) 2020 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .Dd January  2, 2020
  32 .Dt BX509 8
  33 .Os HEIMDAL
  34 .Sh NAME
  35 .Nm bx509d
  36 .Nd Authentication Bridge for Bearer tokens, Kerberos, and PKIX
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl h | Fl Fl help
  40 .Op Fl Fl version
  41 .Op Fl H Ar HOSTNAME
  42 .Op Fl d | Fl Fl daemon
  43 .Op Fl Fl daemon-child
  44 .Op Fl Fl reverse-proxied
  45 .Op Fl p Ar port number (default: 443)
  46 .Op Fl Fl cache-dir= Ns Ar DIRECTORY
  47 .Op Fl Fl cert= Ns Ar HX509-STORE
  48 .Op Fl Fl private-key= Ns Ar HX509-STORE
  49 .Op Fl t | Fl Fl thread-per-client
  50 .Oo Fl v \*(Ba Xo
  51 .Fl Fl verbose= Ns Ar run verbosely
  52 .Xc
  53 .Oc
  54 .Sh DESCRIPTION
  55 Serves RESTful (HTTPS) GETs of
  56 .Ar /bx509 and
  57 .Ar /bnegotiate ,
  58 end-points
  59 performing corresponding kx509 and, possibly, PKINIT requests
  60 to the KDCs of the requested realms (or just the given REALM).
  61 .Pp
  62 Supported options:
  63 .Bl -tag -width Ds
  64 .It Xo
  65 .Fl h ,
  66 .Fl Fl help
  67 .Xc
  68 Print usage message.
  69 .It Xo
  70 .Fl Fl version
  71 .Xc
  72 Print version.
  73 .It Xo
  74 .Fl H Ar HOSTNAME
  75 .Xc
  76 Expected audience(s) of bearer tokens (i.e., acceptor name).
  77 .It Xo
  78 .Fl d ,
  79 .Fl Fl daemon
  80 .Xc
  81 Detach from TTY and run in the background.
  82 .It Xo
  83 .Fl Fl reverse-proxied
  84 .Xc
  85 Serves HTTP instead of HTTPS, accepting only looped-back connections.
  86 .It Xo
  87 .Fl p Ar port number (default: 443)
  88 .Xc
  89 PORT
  90 .It Xo
  91 .Fl Fl cache-dir= Ns Ar DIRECTORY
  92 .Xc
  93 Directory for various caches.  If not specified then a temporary directory will
  94 be made.
  95 .It Xo
  96 .Fl Fl cert= Ns Ar HX509-STORE
  97 .Xc
  98 Certificate file path (PEM) for HTTPS service.  May contain private key as
  99 well.
 100 .It Xo
 101 .Fl Fl private-key= Ns Ar HX509-STORE
 102 .Xc
 103 Private key file path (PEM), if the private key is not stored along with the
 104 certificiate.
 105 .It Xo
 106 .Fl t ,
 107 .Fl Fl thread-per-client
 108 .Xc
 109 Uses a thread per-client instead of as many threads as there are CPUs.
 110 .It Xo
 111 .Fl v ,
 112 .Fl Fl verbose= Ns Ar run verbosely
 113 .Xc
 114 verbose
 115 .El
 116 .Sh ENVIRONMENT
 117 .Bl -tag -width Ds
 118 .It Ev KRB5_CONFIG
 119 The file name of
 120 .Pa krb5.conf ,
 121 the default being
 122 .Pa /etc/krb5.conf .
 123 .El
 124 .Sh FILES
 125 .Bl -tag -width Ds
 126 .It Pa /etc/krb5.conf
 127 .El
 128 .\".Sh EXAMPLES
 129 .Sh DIAGNOSTICS
 130 See logging section of
 131 .Nm krb5.conf.5
 132 .Sh SEE ALSO
 133 .Xr krb5.conf 5
 134 .\".Sh STANDARDS
 135 .\".Sh HISTORY
 136 .\".Sh AUTHORS
 137 .\".Sh BUGS