summaryrefslogtreecommitdiffstats
path: root/crypto/heimdal/doc/doxyout/hx509/man/man3/hx509_print.3
blob: 6523dc651c81efa2329db93ac27b3cc478e46408 (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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
.TH "hx509 printing functions" 3 "30 Sep 2011" "Version 1.5.1" "Heimdalx509library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
hx509 printing functions \- 
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBhx509_print_stdout\fP (void *ctx, const char *fmt, va_list va)"
.br
.ti -1c
.RI "int \fBhx509_oid_sprint\fP (const heim_oid *oid, char **str)"
.br
.ti -1c
.RI "void \fBhx509_oid_print\fP (const heim_oid *oid, hx509_vprint_func func, void *ctx)"
.br
.ti -1c
.RI "void \fBhx509_bitstring_print\fP (const heim_bit_string *b, hx509_vprint_func func, void *ctx)"
.br
.ti -1c
.RI "int \fBhx509_cert_keyusage_print\fP (hx509_context context, hx509_cert c, char **s)"
.br
.ti -1c
.RI "int \fBhx509_validate_ctx_init\fP (hx509_context context, hx509_validate_ctx *ctx)"
.br
.ti -1c
.RI "void \fBhx509_validate_ctx_set_print\fP (hx509_validate_ctx ctx, hx509_vprint_func func, void *c)"
.br
.ti -1c
.RI "void \fBhx509_validate_ctx_add_flags\fP (hx509_validate_ctx ctx, int flags)"
.br
.ti -1c
.RI "void \fBhx509_validate_ctx_free\fP (hx509_validate_ctx ctx)"
.br
.ti -1c
.RI "int \fBhx509_validate_cert\fP (hx509_context context, hx509_validate_ctx ctx, hx509_cert cert)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "void hx509_bitstring_print (const heim_bit_string * b, hx509_vprint_func func, void * ctx)"
.PP
Print a bitstring using a hx509_vprint_func function. To print to stdout use \fBhx509_print_stdout()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIb\fP bit string to print. 
.br
\fIfunc\fP hx509_vprint_func to print with. 
.br
\fIctx\fP context variable to hx509_vprint_func function. 
.RE
.PP

.SS "int hx509_cert_keyusage_print (hx509_context context, hx509_cert c, char ** s)"
.PP
Print certificate usage for a certificate to a string.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP A hx509 context. 
.br
\fIc\fP a certificate print the keyusage for. 
.br
\fIs\fP the return string with the keysage printed in to, free with \fBhx509_xfree()\fP.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

.SS "void hx509_oid_print (const heim_oid * oid, hx509_vprint_func func, void * ctx)"
.PP
Print a oid using a hx509_vprint_func function. To print to stdout use \fBhx509_print_stdout()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIoid\fP oid to print 
.br
\fIfunc\fP hx509_vprint_func to print with. 
.br
\fIctx\fP context variable to hx509_vprint_func function. 
.RE
.PP

.SS "int hx509_oid_sprint (const heim_oid * oid, char ** str)"
.PP
Print a oid to a string.
.PP
\fBParameters:\fP
.RS 4
\fIoid\fP oid to print 
.br
\fIstr\fP allocated string, free with \fBhx509_xfree()\fP.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

.SS "void hx509_print_stdout (void * ctx, const char * fmt, va_list va)"
.PP
Helper function to print on stdout for:
.IP "\(bu" 2
\fBhx509_oid_print()\fP,
.IP "\(bu" 2
\fBhx509_bitstring_print()\fP,
.IP "\(bu" 2
\fBhx509_validate_ctx_set_print()\fP.
.PP
.PP
\fBParameters:\fP
.RS 4
\fIctx\fP the context to the print function. If the ctx is NULL, stdout is used. 
.br
\fIfmt\fP the printing format. 
.br
\fIva\fP the argumet list. 
.RE
.PP

.SS "int hx509_validate_cert (hx509_context context, hx509_validate_ctx ctx, hx509_cert cert)"
.PP
Validate/Print the status of the certificate.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP A hx509 context. 
.br
\fIctx\fP A hx509 validation context. 
.br
\fIcert\fP the cerificate to validate/print.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

.SS "void hx509_validate_ctx_add_flags (hx509_validate_ctx ctx, int flags)"
.PP
Add flags to control the behaivor of the \fBhx509_validate_cert()\fP function.
.PP
\fBParameters:\fP
.RS 4
\fIctx\fP A hx509 validation context. 
.br
\fIflags\fP flags to add to the validation context.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

.SS "void hx509_validate_ctx_free (hx509_validate_ctx ctx)"
.PP
Free an hx509 validate context.
.PP
\fBParameters:\fP
.RS 4
\fIctx\fP the hx509 validate context to free. 
.RE
.PP

.SS "int hx509_validate_ctx_init (hx509_context context, hx509_validate_ctx * ctx)"
.PP
Allocate a hx509 validation/printing context.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP A hx509 context. 
.br
\fIctx\fP a new allocated hx509 validation context, free with \fBhx509_validate_ctx_free()\fP.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

.SS "void hx509_validate_ctx_set_print (hx509_validate_ctx ctx, hx509_vprint_func func, void * c)"
.PP
Set the printing functions for the validation context.
.PP
\fBParameters:\fP
.RS 4
\fIctx\fP a hx509 valication context. 
.br
\fIfunc\fP the printing function to usea. 
.br
\fIc\fP the context variable to the printing function.
.RE
.PP
\fBReturns:\fP
.RS 4
An hx509 error code, see \fBhx509_get_error_string()\fP. 
.RE
.PP

OpenPOWER on IntegriCloud