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

54 lines
1.1 KiB
Groff
Raw Normal View History

.\" @(#)publickey.3r 2.1 88/08/07 4.0 RPCSRC
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
.\"
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
.In rpc/rpc.h
.In rpc/key_prot.h
2001-01-17 18:26:21 +00:00
.Ft int
.Fo getpublickey
2005-11-23 16:44:23 +00:00
.Fa "const char netname[MAXNETNAMELEN+1]"
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
These routines are used to get public and secret keys from the
2001-01-17 18:26:21 +00:00
.Tn YP
database.
2002-12-18 12:45:11 +00:00
The
2001-01-17 18:26:21 +00:00
.Fn getsecretkey
2002-12-18 12:45:11 +00:00
function
has an extra argument,
2001-01-17 18:26:21 +00:00
.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
2001-01-17 18:26:21 +00:00
.Dv NULL Ns \-terminated ,
hexadecimal strings.
If the password supplied to
2001-01-17 18:26:21 +00:00
.Fn getsecretkey
fails to decrypt the secret key, the routine will return 1 but the
2001-01-17 18:26:21 +00:00
.Fa secretkey
argument will be a
2001-01-17 18:26:21 +00:00
.Dv NULL
string
.Pq Dq \& .
2001-01-17 18:26:21 +00:00
.Sh SEE ALSO
.Xr publickey 5
.Pp
.%T "RPC Programmer's Manual"
in
2001-01-17 18:26:21 +00:00
.Pa /usr/share/doc/psd/23.rpc .