secure/lib/libcrypto/man/X509_NAME_get_index_by_NID.3

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