secure/lib/libcrypto/man/X509_NAME_get_index_by_NID.3

   1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "X509_NAME_get_index_by_NID 3"
 127 .TH X509_NAME_get_index_by_NID 3 "2007-10-24" "0.9.8g" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 X509_NAME_get_index_by_NID, X509_NAME_get_index_by_OBJ, X509_NAME_get_entry,
 134 X509_NAME_entry_count, X509_NAME_get_text_by_NID, X509_NAME_get_text_by_OBJ \-
 135 X509_NAME lookup and enumeration functions
 136 .SH "SYNOPSIS"
 137 .IX Header "SYNOPSIS"
 138 int X509_NAME_get_index_by_NID(X509_NAME *name,int nid,int lastpos);
 139 int X509_NAME_get_index_by_OBJ(X509_NAME *name,ASN1_OBJECT *obj, int lastpos);
 140 .PP
 141 int X509_NAME_entry_count(X509_NAME *name);
 142 X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc);
 143 .PP
 144 int X509_NAME_get_text_by_NID(X509_NAME *name, int nid, char *buf,int len);
 145 int X509_NAME_get_text_by_OBJ(X509_NAME *name, \s-1ASN1_OBJECT\s0 *obj, char *buf,int len);
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 These functions allow an \fBX509_NAME\fR structure to be examined. The
 149 \&\fBX509_NAME\fR structure is the same as the \fBName\fR type defined in
 150 \&\s-1RFC2459\s0 (and elsewhere) and used for example in certificate subject
 151 and issuer names.
 152 .PP
 153 \&\fIX509_NAME_get_index_by_NID()\fR and \fIX509_NAME_get_index_by_OBJ()\fR retrieve
 154 the next index matching \fBnid\fR or \fBobj\fR after \fBlastpos\fR. \fBlastpos\fR
 155 should initially be set to \-1. If there are no more entries \-1 is returned.
 156 .PP
 157 \&\fIX509_NAME_entry_count()\fR returns the total number of entries in \fBname\fR.
 158 .PP
 159 \&\fIX509_NAME_get_entry()\fR retrieves the \fBX509_NAME_ENTRY\fR from \fBname\fR
 160 corresponding to index \fBloc\fR. Acceptable values for \fBloc\fR run from
 161 0 to (X509_NAME_entry_count(name) \- 1). The value returned is an
 162 internal pointer which must not be freed.
 163 .PP
 164 \&\fIX509_NAME_get_text_by_NID()\fR, \fIX509_NAME_get_text_by_OBJ()\fR retrieve
 165 the \*(L"text\*(R" from the first entry in \fBname\fR which matches \fBnid\fR or
 166 \&\fBobj\fR, if no such entry exists \-1 is returned. At most \fBlen\fR bytes
 167 will be written and the text written to \fBbuf\fR will be null
 168 terminated. The length of the output string written is returned
 169 excluding the terminating null. If \fBbuf\fR is <\s-1NULL\s0> then the amount
 170 of space needed in \fBbuf\fR (excluding the final null) is returned.
 171 .SH "NOTES"
 172 .IX Header "NOTES"
 173 \&\fIX509_NAME_get_text_by_NID()\fR and \fIX509_NAME_get_text_by_OBJ()\fR are
 174 legacy functions which have various limitations which make them
 175 of minimal use in practice. They can only find the first matching
 176 entry and will copy the contents of the field verbatim: this can
 177 be highly confusing if the target is a muticharacter string type
 178 like a BMPString or a UTF8String.
 179 .PP
 180 For a more general solution \fIX509_NAME_get_index_by_NID()\fR or
 181 \&\fIX509_NAME_get_index_by_OBJ()\fR should be used followed by
 182 \&\fIX509_NAME_get_entry()\fR on any matching indices and then the
 183 various \fBX509_NAME_ENTRY\fR utility functions on the result.
 184 .SH "EXAMPLES"
 185 .IX Header "EXAMPLES"
 186 Process all entries:
 187 .PP
 188 .Vb 2
 189 \& int i;
 190 \& X509_NAME_ENTRY *e;
 191 \&
 192 \& for (i = 0; i < X509_NAME_entry_count(nm); i++)
 193 \&        {
 194 \&        e = X509_NAME_get_entry(nm, i);
 195 \&        /* Do something with e */
 196 \&        }
 197 .Ve
 198 .PP
 199 Process all commonName entries:
 200 .PP
 201 .Vb 2
 202 \& int loc;
 203 \& X509_NAME_ENTRY *e;
 204 \&
 205 \& loc = \-1;
 206 \& for (;;)
 207 \&        {
 208 \&        lastpos = X509_NAME_get_index_by_NID(nm, NID_commonName, lastpos);
 209 \&        if (lastpos == \-1)
 210 \&                break;
 211 \&        e = X509_NAME_get_entry(nm, lastpos);
 212 \&        /* Do something with e */
 213 \&        }
 214 .Ve
 215 .SH "RETURN VALUES"
 216 .IX Header "RETURN VALUES"
 217 \&\fIX509_NAME_get_index_by_NID()\fR and \fIX509_NAME_get_index_by_OBJ()\fR
 218 return the index of the next matching entry or \-1 if not found.
 219 .PP
 220 \&\fIX509_NAME_entry_count()\fR returns the total number of entries.
 221 .PP
 222 \&\fIX509_NAME_get_entry()\fR returns an \fBX509_NAME\fR pointer to the
 223 requested entry or \fB\s-1NULL\s0\fR if the index is invalid.
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fIERR_get_error\fR\|(3), \fId2i_X509_NAME\fR\|(3)
 227 .SH "HISTORY"
 228 .IX Header "HISTORY"
 229 \&\s-1TBA\s0