summaryrefslogtreecommitdiffstats
path: root/doc/doxyout/hx509/man/man3/hx509_peer.3
blob: 3132594ba50ff35f472355c7fadcc140ed233be9 (plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
.TH "hx509 certificate selecting functions" 3 "30 Jul 2011" "Version 1.5" "Heimdalx509library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
hx509 certificate selecting functions \- 
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBhx509_peer_info_alloc\fP (hx509_context context, hx509_peer_info *peer)"
.br
.ti -1c
.RI "void \fBhx509_peer_info_free\fP (hx509_peer_info peer)"
.br
.ti -1c
.RI "int \fBhx509_peer_info_set_cert\fP (hx509_peer_info peer, hx509_cert cert)"
.br
.ti -1c
.RI "int \fBhx509_peer_info_add_cms_alg\fP (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val)"
.br
.ti -1c
.RI "int \fBhx509_peer_info_set_cms_algs\fP (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val, size_t len)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "int hx509_peer_info_add_cms_alg (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier * val)"
.PP
Add an additional algorithm that the peer supports.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP A hx509 context. 
.br
\fIpeer\fP the peer to set the new algorithms for 
.br
\fIval\fP an AlgorithmsIdentier to add
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

.SS "int hx509_peer_info_alloc (hx509_context context, hx509_peer_info * peer)"
.PP
Allocate a new peer info structure an init it to default values.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP A hx509 context. 
.br
\fIpeer\fP return an allocated peer, free with \fBhx509_peer_info_free()\fP.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

.SS "void hx509_peer_info_free (hx509_peer_info peer)"
.PP
Free a peer info structure.
.PP
\fBParameters:\fP
.RS 4
\fIpeer\fP peer info to be freed. 
.RE
.PP

.SS "int hx509_peer_info_set_cert (hx509_peer_info peer, hx509_cert cert)"
.PP
Set the certificate that remote peer is using.
.PP
\fBParameters:\fP
.RS 4
\fIpeer\fP peer info to update 
.br
\fIcert\fP cerificate of the remote peer.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

.SS "int hx509_peer_info_set_cms_algs (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier * val, size_t len)"
.PP
Set the algorithms that the peer supports.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP A hx509 context. 
.br
\fIpeer\fP the peer to set the new algorithms for 
.br
\fIval\fP array of supported AlgorithmsIdentiers 
.br
\fIlen\fP length of array val.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

OpenPOWER on IntegriCloud