1*cdcd9578Sagc.\" $NetBSD: hkpc.1,v 1.3 2014/02/17 07:23:18 agc Exp $ 2267df97bSagc.\" 3267df97bSagc.\" Copyright (c) 2010 The NetBSD Foundation, Inc. 4267df97bSagc.\" All rights reserved. 5267df97bSagc.\" 6267df97bSagc.\" This manual page is derived from software contributed to 7267df97bSagc.\" The NetBSD Foundation by Alistair Crooks (agc@NetBSD.org). 8267df97bSagc.\" 9267df97bSagc.\" Redistribution and use in source and binary forms, with or without 10267df97bSagc.\" modification, are permitted provided that the following conditions 11267df97bSagc.\" are met: 12267df97bSagc.\" 1. Redistributions of source code must retain the above copyright 13267df97bSagc.\" notice, this list of conditions and the following disclaimer. 14267df97bSagc.\" 2. Redistributions in binary form must reproduce the above copyright 15267df97bSagc.\" notice, this list of conditions and the following disclaimer in the 16267df97bSagc.\" documentation and/or other materials provided with the distribution. 17267df97bSagc.\" 18267df97bSagc.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19267df97bSagc.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20267df97bSagc.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21267df97bSagc.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22267df97bSagc.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23267df97bSagc.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24267df97bSagc.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25267df97bSagc.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26267df97bSagc.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27267df97bSagc.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28267df97bSagc.\" POSSIBILITY OF SUCH DAMAGE. 29267df97bSagc.\" 30*cdcd9578Sagc.Dd February 16, 2014 31267df97bSagc.Dt HKPC 1 32267df97bSagc.Os 33267df97bSagc.Sh NAME 34267df97bSagc.Nm hkpc 35267df97bSagc.Nd retrieve public key information via HKP 36267df97bSagc.Sh SYNOPSIS 37267df97bSagc.Nm 38267df97bSagc.Op Fl f address-family 39267df97bSagc.Op Fl h hostname 40267df97bSagc.Op Fl p port 41267df97bSagc.Cm [get|index|vindex] 42267df97bSagcuserid... 43267df97bSagc.Sh DESCRIPTION 44267df97bSagcThe 45267df97bSagc.Nm 46267df97bSagccommand retrieves public key information from the key server daemon 47267df97bSagcusing the HKP protocol. 48267df97bSagcThe 49267df97bSagc.Xr hkpd 8 50267df97bSagcis normally used to retrieve public key information. 51267df97bSagc.Pp 52267df97bSagcThree types of information can be retrieved from the server: 53267df97bSagc.Bl -tag -width vindex 54267df97bSagc.It get 55267df97bSagcThe public key, base64-encoded, corresponding to the given userid 56267df97bSagcis returned. 57267df97bSagcThe userid can be a numeric value, a unique part of the human 58267df97bSagcidentifier, or left blank. 59267df97bSagcThe first matching key will be returned, in a format suitable for 60267df97bSagcimporting to a keyring via the 61267df97bSagc.Xr netpgpkeys 1 62267df97bSagccommand. 63267df97bSagc.It index 64267df97bSagcthe information returned from this command is the same as 65267df97bSagcprovided by the 66267df97bSagc.Xr netpgpkeys 1 67267df97bSagccommand, using the 68267df97bSagc.Dv --list-keys 69267df97bSagcmodifier. 70267df97bSagc.It vindex 71267df97bSagcthe information returned from this command is the same as 72267df97bSagcprovided by the 73267df97bSagc.Xr netpgpkeys 1 74267df97bSagccommand, using the 75267df97bSagc.Dv --list-sigs 76267df97bSagcmodifier. 77267df97bSagc.El 78267df97bSagc.Pp 79267df97bSagcFor this utility to provide the correct results, an hkpd 80267df97bSagcserver must be listening using the correct protocol family, 81267df97bSagcon the provided port on the appropriate server. 82267df97bSagcThe default port for the HKP server is 83267df97bSagc.Dv 11371 , 84267df97bSagcwhilst the hostname defaults to 85267df97bSagc.Dv localhost . 86267df97bSagc.Pp 87267df97bSagcThe 88267df97bSagc.Dv netpgp 89*cdcd9578Sagcsuite of libraries and commands provides a convenient client in 90267df97bSagc.Xr hkpd 1 . 91267df97bSagc.Pp 92267df97bSagcThe information is sent to the server in the form of 93267df97bSagcan HTTP 94267df97bSagc.Dv GET 95267df97bSagccommand, and is returned as a JSON-encoded 96267df97bSagcHKP packet. 97267df97bSagc.Xr libmj 3 98267df97bSagcis used to decode the JSON in the returned HKP packet. 99267df97bSagc.Sh EXIT STATUS 100267df97bSagcThe 101267df97bSagc.Nm 102267df97bSagcutility will return 0 for success, 103267df97bSagcor 1 for failure. 104267df97bSagcOutput will be printed on stdout. 105267df97bSagc.Sh SEE ALSO 106267df97bSagc.Xr hkpd 1 , 107267df97bSagc.Xr netpgpkeys 1 , 108267df97bSagc.Xr ssh 1 , 109267df97bSagc.\" .Xr libbz2 3 , 110267df97bSagc.Xr libmj 3 , 111267df97bSagc.Xr libnetpgp 3 112267df97bSagc.Sh STANDARDS 113*cdcd9578Sagc.Rs 114*cdcd9578Sagc.%A J. Callas 115*cdcd9578Sagc.%A L. Donnerhacke 116*cdcd9578Sagc.%A H. Finney 117*cdcd9578Sagc.%A D. Shaw 118*cdcd9578Sagc.%A R. Thayer 119*cdcd9578Sagc.%D November 2007 120*cdcd9578Sagc.%R RFC 4880 121*cdcd9578Sagc.%T OpenPGP Message Format 122*cdcd9578Sagc.Re 123267df97bSagc.Sh HISTORY 124267df97bSagcThe 125267df97bSagc.Nm 126267df97bSagccommand first appeared in 127267df97bSagc.Nx 6.0 . 128267df97bSagc.Sh AUTHORS 129a5684d07Swiz.An Alistair Crooks Aq Mt agc@NetBSD.org . 130