added connections_setsslserts manual page;
parent
729b8b2913
commit
29e2dc935e
@ -1,2 +1,2 @@
|
||||
man_MANS = sxmsg_rreply.3 connections_create.3 connections_init.3 connections_destroy.3 connections_free.3 \
|
||||
sntl_init.3
|
||||
sntl_init.3 connections_setsslserts.3
|
||||
|
@ -0,0 +1,63 @@
|
||||
.TH CONNECTIONS_SETSSLSERTS 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
|
||||
.SH NAME
|
||||
connections_setsslserts \- Setup root public certificate to check up, and also setups key and public certificate used for connections set
|
||||
.br
|
||||
.SH SYNOPSIS
|
||||
.B #include <sntl/sntllv2.h>
|
||||
.sp
|
||||
int connections_setsslserts(conn_sys_t *ssys, const char *rootca,
|
||||
const char *certpem, const char *certkey);
|
||||
|
||||
.br
|
||||
.sp
|
||||
.SH DESCRIPTION
|
||||
.B connections_setsslserts
|
||||
will setup root public certificate and private key and public certificate used to run connections set.
|
||||
This is required always, see below for more information.
|
||||
.br
|
||||
.sp
|
||||
This function just set a pathname of the certificates for
|
||||
.BI ssys
|
||||
where
|
||||
.BI rootca
|
||||
is a pathname to the public X.509 certificate
|
||||
.BI certpem
|
||||
is a your own X.509 certificate and
|
||||
.BI certkey
|
||||
is a your own key for this certificate. Therefore,
|
||||
.BI certpem
|
||||
and
|
||||
.BI certkey
|
||||
might be a single file.
|
||||
.br
|
||||
.SH RETURN VALUE
|
||||
Will return 0 on success or errors below.
|
||||
.br
|
||||
.SH ERRORS
|
||||
.B EINVAL
|
||||
Invalid pointer given.
|
||||
.br
|
||||
.B ENOMEM
|
||||
There are no available memory for operation.
|
||||
.br
|
||||
.SH BUGS
|
||||
None known yet, but name is historically wrong it should be called connections_setsslcerts, btw there are many
|
||||
code was written with this mistake.
|
||||
.SH EXAMPLE
|
||||
None.
|
||||
.SH APPLICATION USAGE
|
||||
Call this function *always* before linking a connection. Non master link will always avoid non-root certificate and key,
|
||||
since you will required to pass it via call.
|
||||
.SH RATIONALE
|
||||
None.
|
||||
.SH SEE ALSO
|
||||
.BI connection_link(3)
|
||||
,
|
||||
.BI connection_link_master(3)
|
||||
.SH COPYRIGHT
|
||||
This is a proprietary software. See COPYING for further details.
|
||||
.br
|
||||
(c) Askele Group 2013-2015 <http://askele.com>
|
||||
.SH AUTHOR
|
||||
Alexander Vdolainen (vdo@askele.com)
|
||||
|
Loading…
Reference in New Issue