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

   1 .TH "hx509 name functions" 3 "11 Jan 2012" "Version 1.5.2" "Heimdalx509library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 hx509 name functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "int \fBhx509_name_to_string\fP (const hx509_name name, char **str)"
  11 .br
  12 .ti -1c
  13 .RI "int \fBhx509_name_cmp\fP (hx509_name n1, hx509_name n2)"
  14 .br
  15 .ti -1c
  16 .RI "int \fBhx509_parse_name\fP (hx509_context context, const char *str, hx509_name *name)"
  17 .br
  18 .ti -1c
  19 .RI "int \fBhx509_name_copy\fP (hx509_context context, const hx509_name from, hx509_name *to)"
  20 .br
  21 .ti -1c
  22 .RI "int \fBhx509_name_to_Name\fP (const hx509_name from, Name *to)"
  23 .br
  24 .ti -1c
  25 .RI "int \fBhx509_name_expand\fP (hx509_context context, hx509_name name, hx509_env env)"
  26 .br
  27 .ti -1c
  28 .RI "void \fBhx509_name_free\fP (hx509_name *name)"
  29 .br
  30 .ti -1c
  31 .RI "int \fBhx509_unparse_der_name\fP (const void *data, size_t length, char **str)"
  32 .br
  33 .ti -1c
  34 .RI "int \fBhx509_name_binary\fP (const hx509_name name, heim_octet_string *os)"
  35 .br
  36 .ti -1c
  37 .RI "int \fBhx509_name_is_null_p\fP (const hx509_name name)"
  38 .br
  39 .ti -1c
  40 .RI "int \fBhx509_general_name_unparse\fP (GeneralName *name, char **str)"
  41 .br
  42 .in -1c
  43 .SH "Detailed Description"
  44 .PP
  45 See the \fBPKIX/X.509 Names\fP for description and examples.
  46 .SH "Function Documentation"
  47 .PP
  48 .SS "int hx509_general_name_unparse (GeneralName * name, char ** str)"
  49 .PP
  50 Unparse the hx509 name in name into a string.
  51 .PP
  52 \fBParameters:\fP
  53 .RS 4
  54 \fIname\fP the name to print
  55 .br
  56 \fIstr\fP an allocated string returns the name in string form
  57 .RE
  58 .PP
  59 \fBReturns:\fP
  60 .RS 4
  61 An hx509 error code, see \fBhx509_get_error_string()\fP.
  62 .RE
  63 .PP
  64
  65 .SS "int hx509_name_binary (const hx509_name name, heim_octet_string * os)"
  66 .PP
  67 Convert a hx509_name object to DER encoded name.
  68 .PP
  69 \fBParameters:\fP
  70 .RS 4
  71 \fIname\fP name to concert
  72 .br
  73 \fIos\fP data to a DER encoded name, free the resulting octet string with hx509_xfree(os->data).
  74 .RE
  75 .PP
  76 \fBReturns:\fP
  77 .RS 4
  78 An hx509 error code, see \fBhx509_get_error_string()\fP.
  79 .RE
  80 .PP
  81
  82 .SS "int hx509_name_cmp (hx509_name n1, hx509_name n2)"
  83 .PP
  84 Compare to hx509 name object, useful for sorting.
  85 .PP
  86 \fBParameters:\fP
  87 .RS 4
  88 \fIn1\fP a hx509 name object.
  89 .br
  90 \fIn2\fP a hx509 name object.
  91 .RE
  92 .PP
  93 \fBReturns:\fP
  94 .RS 4
  95 0 the objects are the same, returns > 0 is n2 is 'larger' then n2, < 0 if n1 is 'smaller' then n2.
  96 .RE
  97 .PP
  98
  99 .SS "int hx509_name_copy (hx509_context context, const hx509_name from, hx509_name * to)"
 100 .PP
 101 Copy a hx509 name object.
 102 .PP
 103 \fBParameters:\fP
 104 .RS 4
 105 \fIcontext\fP A hx509 cotext.
 106 .br
 107 \fIfrom\fP the name to copy from
 108 .br
 109 \fIto\fP the name to copy to
 110 .RE
 111 .PP
 112 \fBReturns:\fP
 113 .RS 4
 114 An hx509 error code, see \fBhx509_get_error_string()\fP.
 115 .RE
 116 .PP
 117
 118 .SS "int hx509_name_expand (hx509_context context, hx509_name name, hx509_env env)"
 119 .PP
 120 Expands variables in the name using env. Variables are on the form ${name}. Useful when dealing with certificate templates.
 121 .PP
 122 \fBParameters:\fP
 123 .RS 4
 124 \fIcontext\fP A hx509 cotext.
 125 .br
 126 \fIname\fP the name to expand.
 127 .br
 128 \fIenv\fP environment variable to expand.
 129 .RE
 130 .PP
 131 \fBReturns:\fP
 132 .RS 4
 133 An hx509 error code, see \fBhx509_get_error_string()\fP.
 134 .RE
 135 .PP
 136
 137 .PP
 138 Only UTF8String rdnSequence names are allowed
 139 .SS "void hx509_name_free (hx509_name * name)"
 140 .PP
 141 Free a hx509 name object, upond return *name will be NULL.
 142 .PP
 143 \fBParameters:\fP
 144 .RS 4
 145 \fIname\fP a hx509 name object to be freed.
 146 .RE
 147 .PP
 148
 149 .SS "int hx509_name_is_null_p (const hx509_name name)"
 150 .PP
 151 Unparse the hx509 name in name into a string.
 152 .PP
 153 \fBParameters:\fP
 154 .RS 4
 155 \fIname\fP the name to check if its empty/null.
 156 .RE
 157 .PP
 158 \fBReturns:\fP
 159 .RS 4
 160 non zero if the name is empty/null.
 161 .RE
 162 .PP
 163
 164 .SS "int hx509_name_to_Name (const hx509_name from, Name * to)"
 165 .PP
 166 Convert a hx509_name into a Name.
 167 .PP
 168 \fBParameters:\fP
 169 .RS 4
 170 \fIfrom\fP the name to copy from
 171 .br
 172 \fIto\fP the name to copy to
 173 .RE
 174 .PP
 175 \fBReturns:\fP
 176 .RS 4
 177 An hx509 error code, see \fBhx509_get_error_string()\fP.
 178 .RE
 179 .PP
 180
 181 .SS "int hx509_name_to_string (const hx509_name name, char ** str)"
 182 .PP
 183 Convert the hx509 name object into a printable string. The resulting string should be freed with free().
 184 .PP
 185 \fBParameters:\fP
 186 .RS 4
 187 \fIname\fP name to print
 188 .br
 189 \fIstr\fP the string to return
 190 .RE
 191 .PP
 192 \fBReturns:\fP
 193 .RS 4
 194 An hx509 error code, see \fBhx509_get_error_string()\fP.
 195 .RE
 196 .PP
 197
 198 .SS "int hx509_parse_name (hx509_context context, const char * str, hx509_name * name)"
 199 .PP
 200 Parse a string into a hx509 name object.
 201 .PP
 202 \fBParameters:\fP
 203 .RS 4
 204 \fIcontext\fP A hx509 context.
 205 .br
 206 \fIstr\fP a string to parse.
 207 .br
 208 \fIname\fP the resulting object, NULL in case of error.
 209 .RE
 210 .PP
 211 \fBReturns:\fP
 212 .RS 4
 213 An hx509 error code, see \fBhx509_get_error_string()\fP.
 214 .RE
 215 .PP
 216
 217 .SS "int hx509_unparse_der_name (const void * data, size_t length, char ** str)"
 218 .PP
 219 Convert a DER encoded name info a string.
 220 .PP
 221 \fBParameters:\fP
 222 .RS 4
 223 \fIdata\fP data to a DER/BER encoded name
 224 .br
 225 \fIlength\fP length of data
 226 .br
 227 \fIstr\fP the resulting string, is NULL on failure.
 228 .RE
 229 .PP
 230 \fBReturns:\fP
 231 .RS 4
 232 An hx509 error code, see \fBhx509_get_error_string()\fP.
 233 .RE
 234 .PP
 235