From 29e2dc935e22d99dec837062cf0f12a89aed02d1 Mon Sep 17 00:00:00 2001 From: Alexander Vdolainen Date: Sun, 26 Jul 2015 05:47:26 +0300 Subject: [PATCH] added connections_setsslserts manual page; --- debian/libsntl-dev.manpages | 3 +- man/Makefile.am | 2 +- man/connections_setsslserts.3 | 63 +++++++++++++++++++++++++++++++++++ 3 files changed, 66 insertions(+), 2 deletions(-) create mode 100644 man/connections_setsslserts.3 diff --git a/debian/libsntl-dev.manpages b/debian/libsntl-dev.manpages index ccdcda1..2445c82 100644 --- a/debian/libsntl-dev.manpages +++ b/debian/libsntl-dev.manpages @@ -3,4 +3,5 @@ man/connections_create.3 man/connections_destroy.3 man/connections_free.3 man/connections_init.3 -man/sntl_init.3 \ No newline at end of file +man/sntl_init.3 +man/connections_setsslserts.3 \ No newline at end of file diff --git a/man/Makefile.am b/man/Makefile.am index d2eb823..fe07e27 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -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 diff --git a/man/connections_setsslserts.3 b/man/connections_setsslserts.3 new file mode 100644 index 0000000..4977cea --- /dev/null +++ b/man/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 +.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 +.SH AUTHOR +Alexander Vdolainen (vdo@askele.com) +