xref: /minix/crypto/external/bsd/netpgp/dist/src/hkpd/hkpd.1 (revision 0a6a1f1d)
1.\" $NetBSD: hkpd.1,v 1.3 2014/03/18 18:20:35 riastradh Exp $
2.\"
3.\" Copyright (c) 2009,2010 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This manual page is derived from software contributed to
7.\" The NetBSD Foundation by Alistair Crooks (agc@NetBSD.org).
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd September 1, 2010
31.Dt HKPD 1
32.Os
33.Sh NAME
34.Nm hkpd
35.Nd HTTP key protocol daemon
36.Sh SYNOPSIS
37.Nm
38.Op Fl DV
39.Op Fl f families
40.Op Fl H homedir
41.Op Fl h hostname
42.Op Fl p port
43.Op Fl S keyfilename
44.Op Fl v filename
45.Sh DESCRIPTION
46The
47.Nm
48daemon is used to provide public key information on
49a socket to client programs.
50The client can request the information in two separate ways,
51.Dq human
52and
53.Dq machine readable .
54.Pp
55The following options can be used to modify the behaviour
56of the daemon:
57.Bl -tag -width protocol-families
58.It Fl D
59Do not detach the daemon from the controlling tty, and keep the
60.Nm
61process running in the foreground.
62.It Fl f Ar protocol-families
63allows the address families for sockets to be selected.
64The argument is the string concatenating the families,
65with
66.Dq 4
67representing
68.Dv INET4 ,
69and
70.Dq 6
71representing
72.Dv INET6 .
73The default value for this parameter is
74.Dq 46
75which means that both INET4 and INET6 protocol
76families are used when setting up the sockets.
77.It Fl H Ar homedir
78Use the setting of
79.Dv homedir
80as the directory for the public key keyrings.
81.It Fl h Ar hostname
82Set the hostname (for use in binding sockets).
83.It Fl p Ar port
84Set the port number (for use in binding sockets).
85The default port number is the
86.Dq hkp
87service, defined as port
88.Dv 11371 .
89.It Fl S Ar sshkeyfile
90Serve the ssh public keys found in the key file.
91The default file for the ssh key is
92.Pa $HOME/.ssh/id_rsa.pub .
93.It Fl V
94Display the version number of the daemon and exit.
95.It Fl v Ar filename
96Produce extra debugging output from the internal file named
97.Dv filename .
98.El
99.Pp
100The
101.Nm
102daemon is built on
103.Xr libnetpgp 3
104and returns public key information as held in the
105public keyring of the user running the
106.Nm
107daemon utility by default.
108.Pp
109The information returned to the HKP client is encoded
110in JSON using the
111.Xr libmj 3
112library.
113.Sh EXIT STATUS
114In normal operation, the
115.Nm
116daemon will not return.
117.Sh SEE ALSO
118.Xr hkpc 1 ,
119.Xr netpgpkeys 1 ,
120.Xr ssh 1 ,
121.Xr libmj 3
122.Xr libnetpgp 3
123.Sh HISTORY
124The
125.Nm
126command first appeared in
127.Nx 6.0 .
128.Sh AUTHORS
129.An Alistair Crooks Aq Mt agc@NetBSD.org .
130