diff options
Diffstat (limited to 'src/lib/libcrypto/man/ASN1_get_object.3')
| -rw-r--r-- | src/lib/libcrypto/man/ASN1_get_object.3 | 200 |
1 files changed, 0 insertions, 200 deletions
diff --git a/src/lib/libcrypto/man/ASN1_get_object.3 b/src/lib/libcrypto/man/ASN1_get_object.3 deleted file mode 100644 index 781b12ad5a..0000000000 --- a/src/lib/libcrypto/man/ASN1_get_object.3 +++ /dev/null | |||
| @@ -1,200 +0,0 @@ | |||
| 1 | .\" $OpenBSD: ASN1_get_object.3,v 1.2 2021/07/11 19:03:45 schwarze Exp $ | ||
| 2 | .\" | ||
| 3 | .\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> | ||
| 4 | .\" | ||
| 5 | .\" Permission to use, copy, modify, and distribute this software for any | ||
| 6 | .\" purpose with or without fee is hereby granted, provided that the above | ||
| 7 | .\" copyright notice and this permission notice appear in all copies. | ||
| 8 | .\" | ||
| 9 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| 10 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| 11 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| 12 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 13 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| 14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| 15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| 16 | .\" | ||
| 17 | .Dd $Mdocdate: July 11 2021 $ | ||
| 18 | .Dt ASN1_GET_OBJECT 3 | ||
| 19 | .Os | ||
| 20 | .Sh NAME | ||
| 21 | .Nm ASN1_get_object | ||
| 22 | .Nd parse identifier and length octets | ||
| 23 | .Sh SYNOPSIS | ||
| 24 | .In openssl/asn1.h | ||
| 25 | .Ft int | ||
| 26 | .Fo ASN1_get_object | ||
| 27 | .Fa "const unsigned char **ber_in" | ||
| 28 | .Fa "long *plength" | ||
| 29 | .Fa "int *ptag" | ||
| 30 | .Fa "int *pclass" | ||
| 31 | .Fa "long omax" | ||
| 32 | .Fc | ||
| 33 | .Sh DESCRIPTION | ||
| 34 | .Fn ASN1_get_object | ||
| 35 | parses the identifier and length octets of a BER-encoded value. | ||
| 36 | On function entry, | ||
| 37 | .Pf * Fa ber_in | ||
| 38 | is expected to point to the first identifier octet. | ||
| 39 | If the identifier and length octets turn out to be valid, | ||
| 40 | the function advances | ||
| 41 | .Pf * Fa ber_in | ||
| 42 | to the first content octet before returning. | ||
| 43 | .Pp | ||
| 44 | If the identifier octets are valid, | ||
| 45 | .Fn ASN1_get_object | ||
| 46 | stores the tag number in | ||
| 47 | .Pf * Fa ptag | ||
| 48 | and the class of the tag in | ||
| 49 | .Pf * Fa pclass . | ||
| 50 | The class is either | ||
| 51 | .Dv V_ASN1_UNIVERSAL | ||
| 52 | or | ||
| 53 | .Dv V_ASN1_APPLICATION | ||
| 54 | or | ||
| 55 | .Dv V_ASN1_CONTEXT_SPECIFIC | ||
| 56 | or | ||
| 57 | .Dv V_ASN1_PRIVATE . | ||
| 58 | .Pp | ||
| 59 | If the length octets are valid, too, | ||
| 60 | .Fn ASN1_get_object | ||
| 61 | stores the number encoded in the length octets in | ||
| 62 | .Pf * Fa plength . | ||
| 63 | If the length octet indicates the indefinite form, | ||
| 64 | .Pf * Fa plength | ||
| 65 | is set to 0. | ||
| 66 | .Pp | ||
| 67 | .Fn ASN1_get_object | ||
| 68 | inspects at most | ||
| 69 | .Fa omax | ||
| 70 | bytes. | ||
| 71 | If parsing of the length octets remains incomplete after inspecting | ||
| 72 | that number of bytes, parsing fails with | ||
| 73 | .Dv ASN1_R_HEADER_TOO_LONG . | ||
| 74 | .Sh RETURN VALUES | ||
| 75 | Bits set in the return value of | ||
| 76 | .Fn ASN1_get_object | ||
| 77 | have the following meanings: | ||
| 78 | .Bl -tag -width Ds | ||
| 79 | .It 0x80 | ||
| 80 | An error occurred. | ||
| 81 | One of the | ||
| 82 | .Sx ERRORS | ||
| 83 | described below has been set. | ||
| 84 | .It 0x20 = Dv V_ASN1_CONSTRUCTED | ||
| 85 | The encoding is constructed rather than primitive, | ||
| 86 | and the identifier and length octets are valid. | ||
| 87 | .It 0x01 | ||
| 88 | The length octet indicates the indefinite form. | ||
| 89 | This bit can only occur if | ||
| 90 | .Dv V_ASN1_CONSTRUCTED | ||
| 91 | is also set. | ||
| 92 | .El | ||
| 93 | .Pp | ||
| 94 | Consequently, the following combinations can occur: | ||
| 95 | .Bl -tag -width Ds | ||
| 96 | .It 0x00 | ||
| 97 | A valid primitive encoding. | ||
| 98 | .It 0x20 | ||
| 99 | A valid constructed encoding, definite form. | ||
| 100 | .It 0x21 | ||
| 101 | A valid constructed encoding, indefinite form. | ||
| 102 | .It 0x80 | ||
| 103 | Either a primitive encoding with a valid tag and definite length, | ||
| 104 | but the content octets won't fit into | ||
| 105 | .Fa omax , | ||
| 106 | or parsing failed. | ||
| 107 | Use | ||
| 108 | .Xr ERR_GET_REASON 3 | ||
| 109 | to distinguish the two cases. | ||
| 110 | .It 0xa0 | ||
| 111 | A constructed encoding with a valid tag and definite length, | ||
| 112 | but the content octets won't fit into | ||
| 113 | .Fa omax . | ||
| 114 | .El | ||
| 115 | .Pp | ||
| 116 | The bit combinations 0x01, 0x81, and 0xa1 cannot occur as return values. | ||
| 117 | .Sh ERRORS | ||
| 118 | If the bit 0x80 is set in the return value, | ||
| 119 | diagnostics can be retrieved with | ||
| 120 | .Xr ERR_get_error 3 , | ||
| 121 | .Xr ERR_GET_REASON 3 , | ||
| 122 | and | ||
| 123 | .Xr ERR_reason_error_string 3 : | ||
| 124 | .Bl -tag -width Ds | ||
| 125 | .It Dv ASN1_R_HEADER_TOO_LONG Qq "header too long" | ||
| 126 | Inspecting | ||
| 127 | .Fa omax | ||
| 128 | bytes was insufficient to finish parsing, | ||
| 129 | the tag number encoded in the identifier octets exceeds | ||
| 130 | .Dv INT_MAX , | ||
| 131 | the number encoded in the length octets exceeds | ||
| 132 | .Dv LONG_MAX , | ||
| 133 | or using the indefinite form for the length octets is attempted | ||
| 134 | even though the encoding is primitive. | ||
| 135 | .Pp | ||
| 136 | In this case, the return value is exactly 0x80; no other bits are set. | ||
| 137 | .Pp | ||
| 138 | If the problem occurred while parsing the identifier octets, | ||
| 139 | .Pf * Fa ptag | ||
| 140 | and | ||
| 141 | .Pf * Fa pclass | ||
| 142 | remain unchanged. | ||
| 143 | If the problem occurred while parsing the length octets, | ||
| 144 | .Pf * Fa ptag | ||
| 145 | and | ||
| 146 | .Pf * Fa pclass | ||
| 147 | are set according to the identifier octets. | ||
| 148 | In both cases, | ||
| 149 | .Pf * Fa ber_in | ||
| 150 | and | ||
| 151 | .Pf * Fa plength | ||
| 152 | remain unchanged. | ||
| 153 | .Pp | ||
| 154 | The wording of the error message is confusing. | ||
| 155 | On the one hand, the header might be just fine, | ||
| 156 | and the root cause of the problem could be that the chosen | ||
| 157 | .Fa omax | ||
| 158 | argument was too small. | ||
| 159 | On the other hand, outright BER syntax errors are also reported as | ||
| 160 | .Dv ASN1_R_HEADER_TOO_LONG . | ||
| 161 | .It Dv ASN1_R_TOO_LONG Qq "too long" | ||
| 162 | The identifier and length octets are valid, | ||
| 163 | but the content octets won't fit into | ||
| 164 | .Fa omax . | ||
| 165 | The following have been set as appropriate and can safely be inspected: | ||
| 166 | .Pf * pclass , | ||
| 167 | .Pf * ptag , | ||
| 168 | .Pf * plength , | ||
| 169 | and the bits | ||
| 170 | .Dv V_ASN1_CONSTRUCTED | ||
| 171 | and 0x01 in the return value. | ||
| 172 | The parse pointer | ||
| 173 | .Pf * ber_in | ||
| 174 | has been advanced to the first content octet. | ||
| 175 | .Pp | ||
| 176 | Again, the error message may occasionally sound confusing. | ||
| 177 | The length of the content may be reasonable, and the root cause of | ||
| 178 | the problem could be that the chosen | ||
| 179 | .Fa omax | ||
| 180 | argument was too small. | ||
| 181 | .El | ||
| 182 | .Sh SEE ALSO | ||
| 183 | .Xr ASN1_item_d2i 3 , | ||
| 184 | .Xr ASN1_item_new 3 , | ||
| 185 | .Xr ASN1_parse_dump 3 | ||
| 186 | .Sh STANDARDS | ||
| 187 | ITU-T Recommendation X.690, also known as ISO/IEC 8825-1: | ||
| 188 | Information technology - ASN.1 encoding rules: | ||
| 189 | Specification of Basic Encoding Rules (BER), Canonical Encoding | ||
| 190 | Rules (CER) and Distinguished Encoding Rules (DER): | ||
| 191 | .Bl -dash -offset 2n -width 1n -compact | ||
| 192 | .It | ||
| 193 | Section 8.1.2: Identifier octets | ||
| 194 | .It | ||
| 195 | Section 8.1.3: Length octets | ||
| 196 | .El | ||
| 197 | .Sh HISTORY | ||
| 198 | .Fn ASN1_get_object | ||
| 199 | first appeared in SSLeay 0.5.1 and has been available since | ||
| 200 | .Ox 2.4 . | ||
