[thirdparty/man-pages.git] / man3 / key_setsecret.3

.\"  Copyright 2002 walter harms (walter.harms@informatik.uni-oldenburg.de)
.\"
.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
.\" Distributed under GPL
.\" %%%LICENSE_END
.\"
.\"  I had no way the check the functions out
.\"  be careful
.TH KEY_SETSECRET 3 2017-09-15 "" "Linux Programmer's Manual"
.SH NAME
key_decryptsession, key_encryptsession, key_setsecret, key_gendes,
key_secretkey_is_set \- interfaces to rpc keyserver daemon
.SH SYNOPSIS
.B "#include <rpc/rpc.h>"
.PP
.BI "int key_decryptsession(char *" remotename ,
.BI "des_block *" deskey );
.PP
.BI "int key_encryptsession(char *" remotename ,
.BI "des_block *" deskey );
.PP
.BI "int key_gendes(des_block *" deskey );
.PP
.BI "int key_setsecret(char *" key );
.PP
.B "int key_secretkey_is_set(void);"
.SH DESCRIPTION
The functions here are used within the RPC's secure authentication
mechanism (AUTH_DES).
There should be no need for user programs to
use this functions.
.PP
The function
.BR key_decryptsession ()
uses the (remote) server netname and takes the DES key
for decrypting.
It uses the public key of the server and the
secret key associated with the effective UID of the calling process.
.PP
The function
.BR key_encryptsession ()
is the inverse of
.BR key_decryptsession ().
It encrypts the DES keys with the public key of the server and
the secret key associated with the effective UID of the calling process.
.PP
The function
.BR key_gendes ()
is used to ask the keyserver for a secure conversation key.
.PP
The function
.BR key_setsecret ()
is used to set the key for the effective UID of the calling process.
.PP
The function
.BR key_secretkey_is_set ()
can be used to determine whether a key has been
set for the effective UID of the calling process.
.SH RETURN VALUE
These functions return 1 on success and 0 on failure.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lbw22 lb lb
l l l.
Interface	Attribute	Value
T{
.BR key_decryptsession (),
.br
.BR key_encryptsession (),
.br
.BR key_gendes (),
.br
.BR key_setsecret (),
.br
.BR key_secretkey_is_set ()
T}	Thread safety	MT-Safe
.TE
.sp 1
.SH NOTES
Note that we talk about two types of encryption here.
One is asymmetric using a public and secret key.
The other is symmetric, the
64-bit DES.
.PP
These routines were part of the Linux/Doors-project, abandoned by now.
.SH SEE ALSO
.BR crypt (3)
Commit	Line	Data
	1	.\" Copyright 2002 walter harms (walter.harms@informatik.uni-oldenburg.de)
	2	.\"
	3	.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
	4	.\" Distributed under GPL
	5	.\" %%%LICENSE_END
	6	.\"
	7	.\" I had no way the check the functions out
	8	.\" be careful
	9	.TH KEY_SETSECRET 3 2017-09-15 "" "Linux Programmer's Manual"
	10	.SH NAME
	11	key_decryptsession, key_encryptsession, key_setsecret, key_gendes,
	12	key_secretkey_is_set \- interfaces to rpc keyserver daemon
	13	.SH SYNOPSIS
	14	.B "#include <rpc/rpc.h>"
	15	.PP
	16	.BI "int key_decryptsession(char *" remotename ,
	17	.BI "des_block *" deskey );
	18	.PP
	19	.BI "int key_encryptsession(char *" remotename ,
	20	.BI "des_block *" deskey );
	21	.PP
	22	.BI "int key_gendes(des_block *" deskey );
	23	.PP
	24	.BI "int key_setsecret(char *" key );
	25	.PP
	26	.B "int key_secretkey_is_set(void);"
	27	.SH DESCRIPTION
	28	The functions here are used within the RPC's secure authentication
	29	mechanism (AUTH_DES).
	30	There should be no need for user programs to
	31	use this functions.
	32	.PP
	33	The function
	34	.BR key_decryptsession ()
	35	uses the (remote) server netname and takes the DES key
	36	for decrypting.
	37	It uses the public key of the server and the
	38	secret key associated with the effective UID of the calling process.
	39	.PP
	40	The function
	41	.BR key_encryptsession ()
	42	is the inverse of
	43	.BR key_decryptsession ().
	44	It encrypts the DES keys with the public key of the server and
	45	the secret key associated with the effective UID of the calling process.
	46	.PP
	47	The function
	48	.BR key_gendes ()
	49	is used to ask the keyserver for a secure conversation key.
	50	.PP
	51	The function
	52	.BR key_setsecret ()
	53	is used to set the key for the effective UID of the calling process.
	54	.PP
	55	The function
	56	.BR key_secretkey_is_set ()
	57	can be used to determine whether a key has been
	58	set for the effective UID of the calling process.
	59	.SH RETURN VALUE
	60	These functions return 1 on success and 0 on failure.
	61	.SH ATTRIBUTES
	62	For an explanation of the terms used in this section, see
	63	.BR attributes (7).
	64	.TS
	65	allbox;
	66	lbw22 lb lb
	67	l l l.
	68	Interface Attribute Value
	69	T{
	70	.BR key_decryptsession (),
	71	.br
	72	.BR key_encryptsession (),
	73	.br
	74	.BR key_gendes (),
	75	.br
	76	.BR key_setsecret (),
	77	.br
	78	.BR key_secretkey_is_set ()
	79	T} Thread safety MT-Safe
	80	.TE
	81	.sp 1
	82	.SH NOTES
	83	Note that we talk about two types of encryption here.
	84	One is asymmetric using a public and secret key.
	85	The other is symmetric, the
	86	64-bit DES.
	87	.PP
	88	These routines were part of the Linux/Doors-project, abandoned by now.
	89	.SH SEE ALSO
	90	.BR crypt (3)