man(7) -> mdoc(7).

This commit is contained in:
Ruslan Ermilov 2001-01-17 18:26:21 +00:00
parent 86a64baacd
commit 1b51e5d0ce
5 changed files with 1143 additions and 1416 deletions

View file

@ -1,130 +1,123 @@
.\" @(#)des_crypt.3 2.1 88/08/11 4.0 RPCSRC; from 1.16 88/03/02 SMI;
.\" $FreeBSD$
.\"
.TH DES_CRYPT 3 "6 October 1987"
.SH NAME
des_crypt, ecb_crypt, cbc_crypt, des_setparity \- fast DES encryption
.SH SYNOPSIS
.nf
.B #include <des_crypt.h>
.LP
.B int ecb_crypt(key, data, datalen, mode)
.B char *key;
.B char *data;
.B unsigned datalen;
.B unsigned mode;
.LP
.B int cbc_crypt(key, data, datalen, mode, ivec)
.B char *key;
.B char *data;
.B unsigned datalen;
.B unsigned mode;
.B char *ivec;
.LP
.B void des_setparity(key)
.B char *key;
.fi
.SH DESCRIPTION
.IX encryption cbc_crypt "" \fLcbc_crypt\fP
.IX "des encryption" cbc_crypt "DES encryption" \fLcbc_crypt\fP
.IX encryption des_setparity "" \fLdes_setparity\fP
.IX "des encryption" des_setparity "DES encryption" \fLdes_setparity\fP
.B ecb_crypt(\|)
.Dd October 6, 1987
.Dt DES_CRYPT 3
.Os
.Sh NAME
.Nm des_crypt , ecb_crypt , cbc_crypt , des_setparity
.Nd "fast DES encryption"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.Fd "#include <rpc/des_crypt.h>"
.Ft int
.Fn ecb_crypt "char *key" "char *data" "unsigned datalen" "unsigned mode"
.Ft int
.Fn cbc_crypt "char *key" "char *data" "unsigned datalen" "unsigned mode" "char *ivec"
.Ft void
.Fn des_setparity "char *key"
.Sh DESCRIPTION
.Fn ecb_crypt
and
.B cbc_crypt(\|)
.Fn cbc_crypt
implement the
.SM NBS
.SM DES
.Tn NBS
.Tn DES
(Data Encryption Standard).
These routines are faster and more general purpose than
.BR crypt (3).
.Xr crypt 3 .
They also are able to utilize
.SM DES
.Tn DES
hardware if it is available.
.B ecb_crypt(\|)
.Fn ecb_crypt
encrypts in
.SM ECB
.Tn ECB
(Electronic Code Book)
mode, which encrypts blocks of data independently.
.B cbc_crypt(\|)
.Fn cbc_crypt
encrypts in
.SM CBC
.Tn CBC
(Cipher Block Chaining)
mode, which chains together
successive blocks.
.SM CBC
.Tn CBC
mode protects against insertions, deletions and
substitutions of blocks.
Also, regularities in the clear text will
not appear in the cipher text.
.LP
Here is how to use these routines. The first parameter,
.IR key ,
.Pp
Here is how to use these routines.
The first parameter,
.Fa key ,
is the 8-byte encryption key with parity.
To set the key's parity, which for
.SM DES
.Tn DES
is in the low bit of each byte, use
.IR des_setparity .
.Fn des_setparity .
The second parameter,
.IR data ,
.Fa data ,
contains the data to be encrypted or decrypted.
The
third parameter,
.IR datalen ,
.Fa datalen ,
is the length in bytes of
.IR data ,
which must be a multiple of 8. The fourth parameter,
.IR mode ,
.Fa data ,
which must be a multiple of 8.
The fourth parameter,
.Fa mode ,
is formed by
.SM OR\s0'ing
together some things. For the encryption direction 'or' in either
.SM DES_ENCRYPT
.Em OR Ns 'ing
together some things.
For the encryption direction
.Em OR
in either
.Dv DES_ENCRYPT
or
.SM DES_DECRYPT\s0.
.Dv DES_DECRYPT .
For software versus hardware
encryption, 'or' in either
.SM DES_HW
encryption,
.Em OR
in either
.Dv DES_HW
or
.SM DES_SW\s0.
.Dv DES_SW .
If
.SM DES_HW
.Dv DES_HW
is specified, and there is no hardware, then the encryption is performed
in software and the routine returns
.SM DESERR_NOHWDEVICE\s0.
.Er DESERR_NOHWDEVICE .
For
.IR cbc_crypt ,
.Fn cbc_crypt ,
the parameter
.I ivec
.Fa ivec
is the the 8-byte initialization
vector for the chaining. It is updated to the next initialization
vector for the chaining.
It is updated to the next initialization
vector upon return.
.LP
.SH "SEE ALSO"
.BR des (1),
.BR crypt (3)
.SH DIAGNOSTICS
.PD 0
.TP 20
.SM DESERR_NONE
.Sh ERRORS
.Bl -tag -width [DESERR_NOHWDEVICE] -compact
.It Bq Er DESERR_NONE
No error.
.TP
.SM DESERR_NOHWDEVICE
.It Bq Er DESERR_NOHWDEVICE
Encryption succeeded, but done in software instead of the requested hardware.
.TP
.SM DESERR_HWERR
.It Bq Er DESERR_HWERR
An error occurred in the hardware or driver.
.TP
.SM DESERR_BADPARAM
.It Bq Er DESERR_BADPARAM
Bad parameter to routine.
.PD
.LP
.El
.Pp
Given a result status
.IR stat ,
.Va stat ,
the macro
.SM DES_FAILED\c
.BR ( stat )
.Fn DES_FAILED stat
is false only for the first two statuses.
.SH RESTRICTIONS
.Sh SEE ALSO
.\" .Xr des 1 ,
.Xr crypt 3
.Sh RESTRICTIONS
These routines are not available in RPCSRC 4.0.
This information is provided to describe the DES interface expected by
This information is provided to describe the
.Tn DES
interface expected by
Secure RPC.

View file

@ -1,47 +1,51 @@
.\" @(#)publickey.3r 2.1 88/08/07 4.0 RPCSRC
.\" $FreeBSD$
.\"
.TH PUBLICKEY 3R "6 October 1987"
.SH NAME
publickey, getpublickey, getsecretkey \- get public or secret key
.SH SYNOPSIS
.nf
.B #include <rpc/rpc.h>
.B #include <rpc/key_prot.h>
.LP
.B getpublickey(netname, publickey)
.B char netname[\s-1MAXNETNAMELEN\s0+1];
.B char publickey[\s-1HEXKEYBYTES\s0+1];
.LP
.B getsecretkey(netname, secretkey, passwd)
.B char netname[\s-1MAXNETNAMELEN\s0+1];
.B char secretkey[\s-1HEXKEYBYTES\s0+1];
.B char *passwd;
.fi
.SH DESCRIPTION
.IX "getpublickey function" "" "\fLgetpublickey()\fP function"
.IX "getsecretkey function" "" "\fLgetsecretkey()\fP function"
.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
.Fd "#include <rpc/rpc.h>"
.Fd "#include <rpc/key_prot.h>"
.Ft int
.Fo getpublickey
.Fa "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
.SM YP
.Tn YP
database.
.B getsecretkey(\|)
.Fn getsecretkey
has an extra argument,
.IR passwd ,
.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
.SM NULL\s0-terminated,
.Dv NULL Ns \-terminated ,
hexadecimal strings.
If the password supplied to
.B getsecretkey(\|)
.Fn getsecretkey
fails to decrypt the secret key, the routine will return 1 but the
.I secretkey
.Fa secretkey
argument will be a
.SM NULL
string (``'').
.SH "SEE ALSO"
.BR publickey (5)
.LP
.I \s-1RPC\s0 Programmer's Manual
.Dv NULL
string
.Pq Dq .
.Sh SEE ALSO
.Xr publickey 5
.Pp
.%T "RPC Programmer's Manual"
in
.TX NETP
.Pa /usr/share/doc/psd/23.rpc .

View file

@ -1,13 +1,15 @@
.\" $FreeBSD$
.\" @(#)publickey.5 2.1 88/08/07 4.0 RPCSRC; from 1.6 88/02/29 SMI;
.TH PUBLICKEY 5 "19 October 1987"
.SH NAME
publickey \- public key database
.SH SYNOPSIS
.B /etc/publickey
.SH DESCRIPTION
.LP
.B /etc/publickey
.Dd October 19, 1987
.Dt PUBLICKEY 5
.Os
.Sh NAME
.Nm publickey
.Nd "public key database"
.Sh SYNOPSIS
.Pa /etc/publickey
.Sh DESCRIPTION
.Pa /etc/publickey
is the public key database used for secure
networking.
Each entry in
@ -18,21 +20,23 @@ public key (in hex
notation), a colon, and then the user's
secret key encrypted with
its login password (also in hex notation).
.LP
.Pp
This file is altered either by the user through the
.BR chkey (1)
.Xr chkey 1
command or by the system administrator through the
.BR newkey (8)
.Xr newkey 8
command.
The file
.B /etc/publickey
should only contain data on the NIS master machine, where it
.Pa /etc/publickey
should only contain data on the
.Tn NIS
master machine, where it
is converted into the
.SM NIS
.Tn NIS
database
.BR publickey.byname .
.SH SEE ALSO
.BR chkey (1),
.BR publickey (3R),
.BR newkey (8),
.BR ypupdated (8C)
.Pa publickey.byname .
.Sh SEE ALSO
.Xr chkey 1 ,
.Xr publickey 3 ,
.Xr newkey 8 ,
.Xr ypupdated 8

File diff suppressed because it is too large Load diff

View file

@ -1,47 +1,48 @@
.\" @(#)rtime.3n 2.1 88/08/08 4.0 RPCSRC; from 1.5 88/02/08 SMI
.\" $FreeBSD$
.\"
.TH RTIME 3 "22 November 1987"
.SH NAME
rtime \- get remote time
.SH SYNOPSIS
.nf
.B #include <sys/types.h>
.B #include <sys/time.h>
.B #include <netinet/in.h>
.LP
.B int rtime(addrp, timep, timeout)
.B struct sockaddr_in \(**addrp;
.B struct timeval \(**timep;
.B struct timeval \(**timeout;
.fi
.SH DESCRIPTION
.B rtime(\|)
.Dd November 22, 1987
.Dt RTIME 3
.Os
.Sh NAME
.Nm rtime
.Nd "get remote time"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.Fd "#include <sys/types.h>"
.Fd "#include <sys/time.h>"
.Fd "#include <netinet/in.h>"
.Ft int
.Fo rtime
.Fa "struct sockaddr_in *addrp"
.Fa "struct timeval *timep"
.Fa "struct timeval *timeout"
.Fc
.Sh DESCRIPTION
.Fn rtime
consults the Internet Time Server at the address pointed to by
.I addrp
.Fa addrp
and returns the remote time in the
.B timeval
.Vt timeval
struct pointed to by
.IR timep .
.Fa timep .
Normally, the
.SM UDP
.Tn UDP
protocol is used when consulting the Time Server.
The
.I timeout
.Fa timeout
parameter specifies how long the
routine should wait before giving
up when waiting for a reply. If
.I timeout
up when waiting for a reply.
If
.Fa timeout
is specified as
.SM NULL\s0,
.Dv NULL ,
however, the routine will instead use
.SM TCP
.Tn TCP
and block until a reply is received from the time server.
.LP
The routine returns 0 if it is successful.
Otherwise,
it returns \-1 and
.B errno
is set to reflect the cause of the error.
.SH "SEE ALSO"
.BR timed (8c)
.Sh RETURN VALUES
.Rv -std rtime
.Sh SEE ALSO
.Xr timed 8