1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<refentry id="refsslca">
<refmeta>
<refentrytitle>ne_ssl_trust_cert</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname id="ne_ssl_trust_cert">ne_ssl_trust_cert</refname>
<refname id="ne_ssl_trust_default_ca">ne_ssl_trust_default_ca</refname>
<refpurpose>functions to indicate that certificates are trusted</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include <ne_session.h></funcsynopsisinfo>
<funcprototype>
<funcdef>void <function>ne_ssl_trust_cert</function></funcdef>
<paramdef>ne_session *<parameter>session</parameter></paramdef>
<paramdef>const ne_ssl_certificate *<parameter>cert</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>ne_ssl_trust_default_ca</function></funcdef>
<paramdef>ne_session *<parameter>session</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>To indicate that a given certificate is trusted by the
user, the certificate object can be passed to
<function>ne_ssl_trust_cert</function>. The certificate object is
duplicated internally and can subsequently be destroyed.</para>
<para>The SSL library in use by &neon; may include a default
set of CA certificates; calling the
<function>ne_ssl_trust_default_ca</function> function will indicate
that these CAs are trusted by the user.</para>
</refsect1>
<refsect1>
<title>Examples</title>
<para>Load the CA certificate stored in <filename>/path/to/cacert.pem</filename>:</para>
<programlisting>&egsess;
ne_ssl_certificate *cert = ne_ssl_cert_read("/path/to/cacert.pem");
if (cert) {
ne_ssl_trust_cert(sess, cert);
ne_ssl_cert_free(cert);
} else {
printf("Could not load CA cert: %s\n", ne_get_error(sess));
}</programlisting>
</refsect1>
<refsect1>
<title>History</title>
<para><function>ne_ssl_trust_default_ca</function> is not safe
to call for non-SSL sessions versions of &neon; before
0.33.0. In 0.33.0 and later, this function is a no-op for
non-SSL sessions.</para>
</refsect1>
<refsect1>
<title>See also</title>
<para><xref linkend="ne_session_create"/>, <xref linkend="ne_ssl_cert_read"/>, <xref
linkend="ne_ssl_cert_import"/>, <xref
linkend="ne_ssl_cert_free"/></para> </refsect1>
</refentry>
|
