crypto/heimdal/doc/doxyout/hx509/man/man3/hx509_print.3

   1 .TH "hx509 printing functions" 3 "11 Jan 2012" "Version 1.5.2" "Heimdalx509library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 hx509 printing functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "void \fBhx509_print_stdout\fP (void *ctx, const char *fmt, va_list va)"
  11 .br
  12 .ti -1c
  13 .RI "int \fBhx509_oid_sprint\fP (const heim_oid *oid, char **str)"
  14 .br
  15 .ti -1c
  16 .RI "void \fBhx509_oid_print\fP (const heim_oid *oid, hx509_vprint_func func, void *ctx)"
  17 .br
  18 .ti -1c
  19 .RI "void \fBhx509_bitstring_print\fP (const heim_bit_string *b, hx509_vprint_func func, void *ctx)"
  20 .br
  21 .ti -1c
  22 .RI "int \fBhx509_cert_keyusage_print\fP (hx509_context context, hx509_cert c, char **s)"
  23 .br
  24 .ti -1c
  25 .RI "int \fBhx509_validate_ctx_init\fP (hx509_context context, hx509_validate_ctx *ctx)"
  26 .br
  27 .ti -1c
  28 .RI "void \fBhx509_validate_ctx_set_print\fP (hx509_validate_ctx ctx, hx509_vprint_func func, void *c)"
  29 .br
  30 .ti -1c
  31 .RI "void \fBhx509_validate_ctx_add_flags\fP (hx509_validate_ctx ctx, int flags)"
  32 .br
  33 .ti -1c
  34 .RI "void \fBhx509_validate_ctx_free\fP (hx509_validate_ctx ctx)"
  35 .br
  36 .ti -1c
  37 .RI "int \fBhx509_validate_cert\fP (hx509_context context, hx509_validate_ctx ctx, hx509_cert cert)"
  38 .br
  39 .in -1c
  40 .SH "Detailed Description"
  41 .PP
  42
  43 .SH "Function Documentation"
  44 .PP
  45 .SS "void hx509_bitstring_print (const heim_bit_string * b, hx509_vprint_func func, void * ctx)"
  46 .PP
  47 Print a bitstring using a hx509_vprint_func function. To print to stdout use \fBhx509_print_stdout()\fP.
  48 .PP
  49 \fBParameters:\fP
  50 .RS 4
  51 \fIb\fP bit string to print.
  52 .br
  53 \fIfunc\fP hx509_vprint_func to print with.
  54 .br
  55 \fIctx\fP context variable to hx509_vprint_func function.
  56 .RE
  57 .PP
  58
  59 .SS "int hx509_cert_keyusage_print (hx509_context context, hx509_cert c, char ** s)"
  60 .PP
  61 Print certificate usage for a certificate to a string.
  62 .PP
  63 \fBParameters:\fP
  64 .RS 4
  65 \fIcontext\fP A hx509 context.
  66 .br
  67 \fIc\fP a certificate print the keyusage for.
  68 .br
  69 \fIs\fP the return string with the keysage printed in to, free with \fBhx509_xfree()\fP.
  70 .RE
  71 .PP
  72 \fBReturns:\fP
  73 .RS 4
  74 An hx509 error code, see \fBhx509_get_error_string()\fP.
  75 .RE
  76 .PP
  77
  78 .SS "void hx509_oid_print (const heim_oid * oid, hx509_vprint_func func, void * ctx)"
  79 .PP
  80 Print a oid using a hx509_vprint_func function. To print to stdout use \fBhx509_print_stdout()\fP.
  81 .PP
  82 \fBParameters:\fP
  83 .RS 4
  84 \fIoid\fP oid to print
  85 .br
  86 \fIfunc\fP hx509_vprint_func to print with.
  87 .br
  88 \fIctx\fP context variable to hx509_vprint_func function.
  89 .RE
  90 .PP
  91
  92 .SS "int hx509_oid_sprint (const heim_oid * oid, char ** str)"
  93 .PP
  94 Print a oid to a string.
  95 .PP
  96 \fBParameters:\fP
  97 .RS 4
  98 \fIoid\fP oid to print
  99 .br
 100 \fIstr\fP allocated string, free with \fBhx509_xfree()\fP.
 101 .RE
 102 .PP
 103 \fBReturns:\fP
 104 .RS 4
 105 An hx509 error code, see \fBhx509_get_error_string()\fP.
 106 .RE
 107 .PP
 108
 109 .SS "void hx509_print_stdout (void * ctx, const char * fmt, va_list va)"
 110 .PP
 111 Helper function to print on stdout for:
 112 .IP "\(bu" 2
 113 \fBhx509_oid_print()\fP,
 114 .IP "\(bu" 2
 115 \fBhx509_bitstring_print()\fP,
 116 .IP "\(bu" 2
 117 \fBhx509_validate_ctx_set_print()\fP.
 118 .PP
 119 .PP
 120 \fBParameters:\fP
 121 .RS 4
 122 \fIctx\fP the context to the print function. If the ctx is NULL, stdout is used.
 123 .br
 124 \fIfmt\fP the printing format.
 125 .br
 126 \fIva\fP the argumet list.
 127 .RE
 128 .PP
 129
 130 .SS "int hx509_validate_cert (hx509_context context, hx509_validate_ctx ctx, hx509_cert cert)"
 131 .PP
 132 Validate/Print the status of the certificate.
 133 .PP
 134 \fBParameters:\fP
 135 .RS 4
 136 \fIcontext\fP A hx509 context.
 137 .br
 138 \fIctx\fP A hx509 validation context.
 139 .br
 140 \fIcert\fP the cerificate to validate/print.
 141 .RE
 142 .PP
 143 \fBReturns:\fP
 144 .RS 4
 145 An hx509 error code, see \fBhx509_get_error_string()\fP.
 146 .RE
 147 .PP
 148
 149 .SS "void hx509_validate_ctx_add_flags (hx509_validate_ctx ctx, int flags)"
 150 .PP
 151 Add flags to control the behaivor of the \fBhx509_validate_cert()\fP function.
 152 .PP
 153 \fBParameters:\fP
 154 .RS 4
 155 \fIctx\fP A hx509 validation context.
 156 .br
 157 \fIflags\fP flags to add to the validation context.
 158 .RE
 159 .PP
 160 \fBReturns:\fP
 161 .RS 4
 162 An hx509 error code, see \fBhx509_get_error_string()\fP.
 163 .RE
 164 .PP
 165
 166 .SS "void hx509_validate_ctx_free (hx509_validate_ctx ctx)"
 167 .PP
 168 Free an hx509 validate context.
 169 .PP
 170 \fBParameters:\fP
 171 .RS 4
 172 \fIctx\fP the hx509 validate context to free.
 173 .RE
 174 .PP
 175
 176 .SS "int hx509_validate_ctx_init (hx509_context context, hx509_validate_ctx * ctx)"
 177 .PP
 178 Allocate a hx509 validation/printing context.
 179 .PP
 180 \fBParameters:\fP
 181 .RS 4
 182 \fIcontext\fP A hx509 context.
 183 .br
 184 \fIctx\fP a new allocated hx509 validation context, free with \fBhx509_validate_ctx_free()\fP.
 185 .RE
 186 .PP
 187 \fBReturns:\fP
 188 .RS 4
 189 An hx509 error code, see \fBhx509_get_error_string()\fP.
 190 .RE
 191 .PP
 192
 193 .SS "void hx509_validate_ctx_set_print (hx509_validate_ctx ctx, hx509_vprint_func func, void * c)"
 194 .PP
 195 Set the printing functions for the validation context.
 196 .PP
 197 \fBParameters:\fP
 198 .RS 4
 199 \fIctx\fP a hx509 valication context.
 200 .br
 201 \fIfunc\fP the printing function to usea.
 202 .br
 203 \fIc\fP the context variable to the printing function.
 204 .RE
 205 .PP
 206 \fBReturns:\fP
 207 .RS 4
 208 An hx509 error code, see \fBhx509_get_error_string()\fP.
 209 .RE
 210 .PP
 211