diff options
author | sheldonh <sheldonh@FreeBSD.org> | 2000-03-02 09:14:21 +0000 |
---|---|---|
committer | sheldonh <sheldonh@FreeBSD.org> | 2000-03-02 09:14:21 +0000 |
commit | 329223e6f229a55ee8fed800f358f30e994ed749 (patch) | |
tree | 5d5e6c715ccfb778a29f10e1ea16f06731edbda8 /lib/libc/rpc | |
parent | 05f0a865546b5e0b902987be72a75a7b0ef85d09 (diff) | |
download | FreeBSD-src-329223e6f229a55ee8fed800f358f30e994ed749.zip FreeBSD-src-329223e6f229a55ee8fed800f358f30e994ed749.tar.gz |
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.
Diffstat (limited to 'lib/libc/rpc')
-rw-r--r-- | lib/libc/rpc/des_crypt.3 | 6 | ||||
-rw-r--r-- | lib/libc/rpc/publickey.3 | 3 | ||||
-rw-r--r-- | lib/libc/rpc/publickey.5 | 3 | ||||
-rw-r--r-- | lib/libc/rpc/rpc.3 | 81 | ||||
-rw-r--r-- | lib/libc/rpc/rpc_secure.3 | 45 | ||||
-rw-r--r-- | lib/libc/rpc/rtime.3 | 6 |
6 files changed, 96 insertions, 48 deletions
diff --git a/lib/libc/rpc/des_crypt.3 b/lib/libc/rpc/des_crypt.3 index 00ddda9..e8651fe 100644 --- a/lib/libc/rpc/des_crypt.3 +++ b/lib/libc/rpc/des_crypt.3 @@ -54,7 +54,8 @@ mode, which chains together successive blocks. .SM CBC mode protects against insertions, deletions and -substitutions of blocks. Also, regularities in the clear text will +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, @@ -66,7 +67,8 @@ is in the low bit of each byte, use .IR des_setparity . The second parameter, .IR data , -contains the data to be encrypted or decrypted. The +contains the data to be encrypted or decrypted. +The third parameter, .IR datalen , is the length in bytes of diff --git a/lib/libc/rpc/publickey.3 b/lib/libc/rpc/publickey.3 index 7f32e49..79608d6 100644 --- a/lib/libc/rpc/publickey.3 +++ b/lib/libc/rpc/publickey.3 @@ -31,7 +31,8 @@ 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, -hexadecimal strings. If the password supplied to +hexadecimal strings. +If the password supplied to .B getsecretkey(\|) fails to decrypt the secret key, the routine will return 1 but the .I secretkey diff --git a/lib/libc/rpc/publickey.5 b/lib/libc/rpc/publickey.5 index 806028f..b289933 100644 --- a/lib/libc/rpc/publickey.5 +++ b/lib/libc/rpc/publickey.5 @@ -9,7 +9,8 @@ publickey \- public key database .LP .B /etc/publickey is the public key database used for secure -networking. Each entry in +networking. +Each entry in the database consists of a network user name (which may either refer to a user or a hostname), followed by the user's diff --git a/lib/libc/rpc/rpc.3 b/lib/libc/rpc/rpc.3 index 92b0d98..89d8942 100644 --- a/lib/libc/rpc/rpc.3 +++ b/lib/libc/rpc/rpc.3 @@ -39,7 +39,8 @@ auth_destroy(auth) A macro that destroys the authentication information associated with .IR auth . Destruction usually involves deallocation of private data -structures. The use of +structures. +The use of .I auth is undefined after calling .BR auth_destroy(\|) . @@ -57,7 +58,8 @@ authnone_create(\|) Create and returns an .SM RPC authentication handle that passes nonusable authentication -information with each remote procedure call. This is the +information with each remote procedure call. +This is the default authentication used by .SM RPC. .if t .ne 10 @@ -169,7 +171,8 @@ resultproc_t eachresult; Like .BR callrpc(\|) , except the call message is broadcast to all locally -connected broadcast nets. Each time it receives a +connected broadcast nets. +Each time it receives a response, this routine calls .BR eachresult(\|) , whose form is: @@ -201,7 +204,8 @@ waits for more replies; otherwise it returns with appropriate status. .IP Warning: broadcast sockets are limited in size to the -maximum transfer unit of the data link. For ethernet, +maximum transfer unit of the data link. +For ethernet, this value is 1500 bytes. .br .if t .ne 13 @@ -252,7 +256,8 @@ clnt_destroy(clnt) .IP A macro that destroys the client's .SM RPC -handle. Destruction usually involves deallocation +handle. +Destruction usually involves deallocation of private data structures, including .I clnt itself. Use of @@ -282,7 +287,8 @@ Generic client creation routine. identifies the name of the remote host where the server is located. .I proto -indicates which kind of transport protocol to use. The +indicates which kind of transport protocol to use. +The currently supported values for this field are \(lqudp\(rq and \(lqtcp\(rq. Default timeouts are set, but can be modified using @@ -315,7 +321,8 @@ about a client object. .I req indicates the type of operation, and .I info -is a pointer to the information. For both +is a pointer to the information. +For both .SM UDP and .SM TCP\s0, @@ -573,7 +580,8 @@ This allows simulation of and acquisition of .SM RPC overheads, such as round trip times, without any -kernel interference. This routine returns +kernel interference. +This routine returns .SM NULL if it fails. .br @@ -599,7 +607,8 @@ version .IR versnum ; the client uses .SM TCP/IP -as a transport. The remote program is located at Internet +as a transport. +The remote program is located at Internet address .IR *addr . If @@ -651,7 +660,8 @@ version .IR versnum ; the client uses .SM UDP/IP -as a transport. The remote program is located at Internet +as a transport. +The remote program is located at Internet address .IR addr . If @@ -705,7 +715,8 @@ on .IR versnum ; the client uses .SM UDP/IP -as a transport. The remote program is located at Internet +as a transport. +The remote program is located at Internet address .IR addr . If @@ -851,7 +862,8 @@ The parameter .I *portp will be modified to the program's port number if the procedure -succeeds. The definitions of other parameters are discussed +succeeds. +The definitions of other parameters are discussed in .B callrpc(\|) and @@ -880,7 +892,8 @@ and .I port on the machine's .B portmap -service. The value of +service. +The value of .I protocol is most likely .B @@ -909,7 +922,8 @@ and .B ports on the machine's .B portmap -service. This routine returns one if it succeeds, zero +service. +This routine returns one if it succeeds, zero otherwise. .br .if t .ne 15 @@ -1004,7 +1018,8 @@ service side's read file descriptor bit mask; it is suitable as a template parameter to the .B select -system call. This is only of interest +system call. +This is only of interest if a service implementor does not call .BR svc_run(\|) , but rather does his own asynchronous event processing. @@ -1032,7 +1047,8 @@ int svc_fds; .IP Similar to .BR svc_fedset(\|) , -but limited to 32 descriptors. This +but limited to 32 descriptors. +This interface is obsoleted by .BR svc_fdset(\|) . .br @@ -1143,7 +1159,8 @@ int rdfds; .IP Similar to .BR svc_getreqset(\|) , -but limited to 32 descriptors. This interface is obsoleted by +but limited to 32 descriptors. +This interface is obsoleted by .BR svc_getreqset(\|) . .br .if t .ne 17 @@ -1212,12 +1229,14 @@ svc_run(\|) .fi .ft R .IP -This routine never returns. It waits for +This routine never returns. +It waits for .SM RPC requests to arrive, and calls the appropriate service procedure using .B svc_getreq(\|) -when one arrives. This procedure is usually waiting for a +when one arrives. +This procedure is usually waiting for a .B select(\|) system call to return. .br @@ -1291,7 +1310,8 @@ svcerr_decode(xprt) .ft R .IP Called by a service dispatch routine that cannot successfully -decode its parameters. See also +decode its parameters. +See also .BR svc_getargs(\|) . .br .if t .ne 7 @@ -1321,7 +1341,8 @@ svcerr_noprog(xprt) .IP Called when the desired program is not registered with the .SM RPC -package. Service implementors usually do not need this routine. +package. +Service implementors usually do not need this routine. .br .if t .ne 7 .LP @@ -1337,7 +1358,8 @@ svcerr_progvers(xprt) Called when the desired version of a program is not registered with the .SM RPC -package. Service implementors usually do not need this routine. +package. +Service implementors usually do not need this routine. .br .if t .ne 7 .LP @@ -1434,7 +1456,8 @@ is the transport's socket descriptor, and is the transport's port number. This routine returns .SM NULL -if it fails. Since +if it fails. +Since .SM TCP\s0-based .SM RPC uses buffered @@ -1455,7 +1478,8 @@ u_int recvsize; .fi .ft R .IP -Create a service on top of any open descriptor. Typically, +Create a service on top of any open descriptor. +Typically, this descriptor is a connected socket for a stream protocol such as @@ -1488,7 +1512,8 @@ which may be in which case a new socket is created. If the socket is not bound to a local .SM UDP -port, then this routine binds it to an arbitrary port. Upon +port, then this routine binds it to an arbitrary port. +Upon completion, \fB\%xprt\->xp_sock\fR is the transport's socket descriptor, and @@ -1516,7 +1541,8 @@ struct accepted_reply *ar; .IP Used for encoding .SM RPC -reply messages. This routine is useful for users who +reply messages. +This routine is useful for users who wish to generate \s-1RPC\s0-style messages without using the @@ -1536,7 +1562,8 @@ struct authunix_parms *aupp; .IP Used for describing .SM UNIX -credentials. This routine is useful for users +credentials. +This routine is useful for users who wish to generate these credentials without using the .SM RPC authentication package. diff --git a/lib/libc/rpc/rpc_secure.3 b/lib/libc/rpc/rpc_secure.3 index 23f1a7e..f3e57cc 100644 --- a/lib/libc/rpc/rpc_secure.3 +++ b/lib/libc/rpc/rpc_secure.3 @@ -69,7 +69,8 @@ The first parameter .Fa name is the network name, or .Fa netname , -of the owner of the server process. This field usually +of the owner of the server process. +This field usually represents a .Fa hostname derived from the utility routine @@ -80,21 +81,25 @@ The second field is window on the validity of the client credential, given in seconds. A small window is more secure than a large one, but choosing too small of a window will increase the frequency of -resynchronizations because of clock drift. The third +resynchronizations because of clock drift. +The third parameter .Fa addr is optional. If it is .Dv NULL , then the authentication system will assume that the local clock is always in sync with the server's -clock, and will not attempt resynchronizations. If an address +clock, and will not attempt resynchronizations. +If an address is supplied, however, then the system will use the address for consulting the remote time service whenever resynchronization -is required. This parameter is usually the +is required. +This parameter is usually the address of the .Tn RPC -server itself. The final parameter +server itself. +The final parameter .Fa ckey is also optional. If it is .Dv NULL , @@ -113,7 +118,8 @@ is used on the server side for converting a credential, which is operating system independent, into a .Ux -credential. This routine differs from utility routine +credential. +This routine differs from utility routine .Fn netname2user in that .Fn authdes_getucred @@ -133,11 +139,13 @@ if it fails. .Pp .Fn Host2netname converts from a domain-specific hostname to an -operating-system independent netname. Returns +operating-system independent netname. +Returns .Dv TRUE if it succeeds and .Dv FALSE -if it fails. Inverse of +if it fails. +Inverse of .Fn netname2host . .Pp .Fn Key_decryptsession @@ -168,7 +176,8 @@ is the inverse of .Fn key_encryptsession . .Pp .Fn Key_encryptsession -is a keyserver interface routine. It +is a keyserver interface routine. +It takes a server netname and a des key, and encrypts it using the public key of the the server and the secret key associated with the effective uid of the calling process. It @@ -176,7 +185,8 @@ is the inverse of .Fn key_decryptsession . .Pp .Fn Key_gendes -is a keyserver interface routine. It +is a keyserver interface routine. +It is used to ask the keyserver for a secure conversation key. Choosing one .Qq random @@ -186,14 +196,16 @@ the common ways of choosing random numbers, such as using the current time, are very easy to guess. .Pp .Fn Key_setsecret -is a keyserver interface routine. It is used to set the key for +is a keyserver interface routine. +It is used to set the key for the effective .Fa uid of the calling process. .Pp .Fn Netname2host converts from an operating-system independent netname to a -domain-specific hostname. Returns +domain-specific hostname. +Returns .Dv TRUE if it succeeds and .Dv FALSE @@ -207,16 +219,19 @@ Returns .Dv TRUE if it succeeds and .Dv FALSE -if it fails. Inverse of +if it fails. +Inverse of .Fn user2netname . .Pp .Fn User2netname converts from a domain-specific username to an operating-system -independent netname. Returns +independent netname. +Returns .Dv TRUE if it succeeds and .Dv FALSE -if it fails. Inverse of +if it fails. +Inverse of .Fn netname2user . .Sh SEE ALSO .Xr rpc 3 , diff --git a/lib/libc/rpc/rtime.3 b/lib/libc/rpc/rtime.3 index de19866..6847e15 100644 --- a/lib/libc/rpc/rtime.3 +++ b/lib/libc/rpc/rtime.3 @@ -25,7 +25,8 @@ struct pointed to by .IR timep . Normally, the .SM UDP -protocol is used when consulting the Time Server. The +protocol is used when consulting the Time Server. +The .I timeout parameter specifies how long the routine should wait before giving @@ -37,7 +38,8 @@ however, the routine will instead use .SM TCP and block until a reply is received from the time server. .LP -The routine returns 0 if it is successful. Otherwise, +The routine returns 0 if it is successful. +Otherwise, it returns \-1 and .B errno is set to reflect the cause of the error. |