freebsd-dev/lib/libc/rpc/publickey.3

.\" @(#)publickey.3r	2.1 88/08/07 4.0 RPCSRC
.\" $FreeBSD$
.\"
.Dd October 6, 1987
.Dt PUBLICKEY 3
.Os
.Sh NAME
.Nm publickey , getpublickey , getsecretkey
.Nd "get public or secret key"
.Sh LIBRARY
.Lb librpcsvc
.Sh SYNOPSIS
.In rpc/rpc.h
.In rpc/key_prot.h
.Ft int
.Fo getpublickey
.Fa "const char netname[MAXNETNAMELEN+1]"
.Fa "char publickey[HEXKEYBYTES+1]"
.Fc
.Ft int
.Fo getsecretkey
.Fa "char netname[MAXNETNAMELEN+1]"
.Fa "char secretkey[HEXKEYBYTES+1]"
.Fa "char *passwd"
.Fc
.Sh DESCRIPTION
These routines are used to get public and secret keys from the
.Tn YP
database.
The
.Fn getsecretkey
function
has an extra argument,
.Fa passwd ,
which is used to decrypt the encrypted secret key stored in the database.
Both routines return 1 if they are successful in finding the key, 0 otherwise.
The keys are returned as
.Dv NUL Ns \-terminated ,
hexadecimal strings.
If the password supplied to
.Fn getsecretkey
fails to decrypt the secret key, the routine will return 1 but the
.Fa secretkey
argument will be a
.Dv NUL
string
.Pq Dq .
.Sh SEE ALSO
.Xr publickey 5
.Pp
.%T "RPC Programmer's Manual"
in
.Pa /usr/share/doc/psd/23.rpc .
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`.\" @(#)publickey.3r 2.1 88/08/07 4.0 RPCSRC`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add $Id$, to make it simpler for members of the translation teams to track. The $Id$ line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde 1999-07-12 20:50:10 +00:00			`.\"`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Dd October 6, 1987`
			`.Dt PUBLICKEY 3`
			`.Os`
			`.Sh NAME`
			`.Nm publickey , getpublickey , getsecretkey`
			`.Nd "get public or secret key"`
			`.Sh LIBRARY`
			`.Lb librpcsvc`
			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In rpc/rpc.h`
			`.In rpc/key_prot.h`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Ft int`
			`.Fo getpublickey`
Fix prototypes. 2005-11-23 16:44:23 +00:00			`.Fa "const char netname[MAXNETNAMELEN+1]"`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fa "char publickey[HEXKEYBYTES+1]"`
			`.Fc`
			`.Ft int`
			`.Fo getsecretkey`
			`.Fa "char netname[MAXNETNAMELEN+1]"`
			`.Fa "char secretkey[HEXKEYBYTES+1]"`
			`.Fa "char *passwd"`
			`.Fc`
			`.Sh DESCRIPTION`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`These routines are used to get public and secret keys from the`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Tn YP`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`database.`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`The`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fn getsecretkey`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`function`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`has an extra argument,`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fa passwd ,`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`which is used to decrypt the encrypted secret key stored in the database.`
			`Both routines return 1 if they are successful in finding the key, 0 otherwise.`
			`The keys are returned as`
General mdoc(7) and typo fixes. PR: 167734 Submitted by: Nobuyuki Koganemaru (kogane!jp.freebsd.org) MFC after: 3 days 2012-05-11 20:06:46 +00:00			`.Dv NUL Ns \-terminated ,`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-02 09:14:21 +00:00			`hexadecimal strings.`
			`If the password supplied to`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fn getsecretkey`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`fails to decrypt the secret key, the routine will return 1 but the`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fa secretkey`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`argument will be a`
General mdoc(7) and typo fixes. PR: 167734 Submitted by: Nobuyuki Koganemaru (kogane!jp.freebsd.org) MFC after: 3 days 2012-05-11 20:06:46 +00:00			`.Dv NUL`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`string`
Revert most of r210764, now that mdocml does the right thing with empty quotation macros. Requested by: Alex Kozlov 2010-12-28 10:08:50 +00:00			`.Pq Dq .`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Sh SEE ALSO`
			`.Xr publickey 5`
			`.Pp`
			`.%T "RPC Programmer's Manual"`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`in`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Pa /usr/share/doc/psd/23.rpc .`