diff options
| -rw-r--r-- | src/lib/libcrypto/man/X509_NAME_get_index_by_NID.3 | 76 |
1 files changed, 72 insertions, 4 deletions
diff --git a/src/lib/libcrypto/man/X509_NAME_get_index_by_NID.3 b/src/lib/libcrypto/man/X509_NAME_get_index_by_NID.3 index fdf8bb1a81..0f3adbc081 100644 --- a/src/lib/libcrypto/man/X509_NAME_get_index_by_NID.3 +++ b/src/lib/libcrypto/man/X509_NAME_get_index_by_NID.3 | |||
| @@ -1,6 +1,55 @@ | |||
| 1 | .\" $OpenBSD: X509_NAME_get_index_by_NID.3,v 1.3 2016/12/03 13:36:03 jmc Exp $ | 1 | .\" $OpenBSD: X509_NAME_get_index_by_NID.3,v 1.4 2016/12/05 12:11:26 schwarze Exp $ |
| 2 | .\" OpenSSL aebb9aac Jul 19 09:27:53 2016 -0400 | ||
| 2 | .\" | 3 | .\" |
| 3 | .Dd $Mdocdate: December 3 2016 $ | 4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. |
| 5 | .\" Copyright (c) 2002, 2006, 2014, 2015, 2016 The OpenSSL Project. | ||
| 6 | .\" All rights reserved. | ||
| 7 | .\" | ||
| 8 | .\" Redistribution and use in source and binary forms, with or without | ||
| 9 | .\" modification, are permitted provided that the following conditions | ||
| 10 | .\" are met: | ||
| 11 | .\" | ||
| 12 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 13 | .\" notice, this list of conditions and the following disclaimer. | ||
| 14 | .\" | ||
| 15 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 16 | .\" notice, this list of conditions and the following disclaimer in | ||
| 17 | .\" the documentation and/or other materials provided with the | ||
| 18 | .\" distribution. | ||
| 19 | .\" | ||
| 20 | .\" 3. All advertising materials mentioning features or use of this | ||
| 21 | .\" software must display the following acknowledgment: | ||
| 22 | .\" "This product includes software developed by the OpenSSL Project | ||
| 23 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
| 24 | .\" | ||
| 25 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
| 26 | .\" endorse or promote products derived from this software without | ||
| 27 | .\" prior written permission. For written permission, please contact | ||
| 28 | .\" openssl-core@openssl.org. | ||
| 29 | .\" | ||
| 30 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
| 31 | .\" nor may "OpenSSL" appear in their names without prior written | ||
| 32 | .\" permission of the OpenSSL Project. | ||
| 33 | .\" | ||
| 34 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
| 35 | .\" acknowledgment: | ||
| 36 | .\" "This product includes software developed by the OpenSSL Project | ||
| 37 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
| 38 | .\" | ||
| 39 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
| 40 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 41 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| 42 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
| 43 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| 44 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
| 45 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| 46 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 47 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
| 48 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| 49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
| 50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| 51 | .\" | ||
| 52 | .Dd $Mdocdate: December 5 2016 $ | ||
| 4 | .Dt X509_NAME_GET_INDEX_BY_NID 3 | 53 | .Dt X509_NAME_GET_INDEX_BY_NID 3 |
| 5 | .Os | 54 | .Os |
| 6 | .Sh NAME | 55 | .Sh NAME |
| @@ -71,6 +120,9 @@ after | |||
| 71 | .Fa lastpos | 120 | .Fa lastpos |
| 72 | should initially be set to -1. | 121 | should initially be set to -1. |
| 73 | If there are no more entries, -1 is returned. | 122 | If there are no more entries, -1 is returned. |
| 123 | If | ||
| 124 | .Fa nid | ||
| 125 | is invalid (doesn't correspond to a valid OID), -2 is returned. | ||
| 74 | .Pp | 126 | .Pp |
| 75 | .Fn X509_NAME_entry_count | 127 | .Fn X509_NAME_entry_count |
| 76 | returns the total number of entries in | 128 | returns the total number of entries in |
| @@ -114,6 +166,23 @@ is | |||
| 114 | then the amount of space needed in | 166 | then the amount of space needed in |
| 115 | .Fa buf | 167 | .Fa buf |
| 116 | (excluding the final NUL) is returned. | 168 | (excluding the final NUL) is returned. |
| 169 | .Pp | ||
| 170 | All relevant | ||
| 171 | .Dv NID_* | ||
| 172 | and | ||
| 173 | .Dv OBJ_* | ||
| 174 | codes can be found in the header files | ||
| 175 | .In openssl/obj_mac.h | ||
| 176 | and | ||
| 177 | .In openssl/objects.h . | ||
| 178 | .Pp | ||
| 179 | Applications which could pass invalid NIDs to | ||
| 180 | .Fn X509_NAME_get_index_by_NID | ||
| 181 | should check for the return value of -2. | ||
| 182 | Alternatively the NID validity can be determined first by checking that | ||
| 183 | .Fn OBJ_nid2obj nid | ||
| 184 | is not | ||
| 185 | .Dv NULL . | ||
| 117 | .Sh RETURN VALUES | 186 | .Sh RETURN VALUES |
| 118 | .Fn X509_NAME_get_index_by_NID | 187 | .Fn X509_NAME_get_index_by_NID |
| 119 | and | 188 | and |
| @@ -143,10 +212,9 @@ for (i = 0; i < X509_NAME_entry_count(nm); i++) { | |||
| 143 | .Pp | 212 | .Pp |
| 144 | Process all commonName entries: | 213 | Process all commonName entries: |
| 145 | .Bd -literal | 214 | .Bd -literal |
| 146 | int loc; | 215 | int lastpos = -1; |
| 147 | X509_NAME_ENTRY *e; | 216 | X509_NAME_ENTRY *e; |
| 148 | 217 | ||
| 149 | loc = -1; | ||
| 150 | for (;;) { | 218 | for (;;) { |
| 151 | lastpos = X509_NAME_get_index_by_NID(nm, NID_commonName, lastpos); | 219 | lastpos = X509_NAME_get_index_by_NID(nm, NID_commonName, lastpos); |
| 152 | if (lastpos == -1) | 220 | if (lastpos == -1) |
