diff options
Diffstat (limited to 'src/lib/libcrypto/man')
| -rw-r--r-- | src/lib/libcrypto/man/ASN1_BIT_STRING_set.3 | 178 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/ASN1_STRING_length.3 | 3 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/ASN1_STRING_new.3 | 3 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/Makefile | 3 |
4 files changed, 184 insertions, 3 deletions
diff --git a/src/lib/libcrypto/man/ASN1_BIT_STRING_set.3 b/src/lib/libcrypto/man/ASN1_BIT_STRING_set.3 new file mode 100644 index 0000000000..608c3ef1b8 --- /dev/null +++ b/src/lib/libcrypto/man/ASN1_BIT_STRING_set.3 | |||
| @@ -0,0 +1,178 @@ | |||
| 1 | .\" $OpenBSD: ASN1_BIT_STRING_set.3,v 1.1 2021/11/15 16:18:36 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: November 15 2021 $ | ||
| 18 | .Dt ASN1_BIT_STRING_SET 3 | ||
| 19 | .Os | ||
| 20 | .Sh NAME | ||
| 21 | .Nm ASN1_BIT_STRING_set , | ||
| 22 | .Nm ASN1_BIT_STRING_set_bit , | ||
| 23 | .Nm ASN1_BIT_STRING_get_bit , | ||
| 24 | .Nm ASN1_BIT_STRING_check | ||
| 25 | .Nd ASN.1 BIT STRING accessors | ||
| 26 | .Sh SYNOPSIS | ||
| 27 | .In openssl/asn1.h | ||
| 28 | .Ft int | ||
| 29 | .Fo ASN1_BIT_STRING_set | ||
| 30 | .Fa "ASN1_BIT_STRING *bitstr" | ||
| 31 | .Fa "unsigned char *data" | ||
| 32 | .Fa "int len" | ||
| 33 | .Fc | ||
| 34 | .Ft int | ||
| 35 | .Fo ASN1_BIT_STRING_set_bit | ||
| 36 | .Fa "ASN1_BIT_STRING *bitstr" | ||
| 37 | .Fa "int bitnumber" | ||
| 38 | .Fa "int set" | ||
| 39 | .Fc | ||
| 40 | .Ft int | ||
| 41 | .Fo ASN1_BIT_STRING_get_bit | ||
| 42 | .Fa "ASN1_BIT_STRING *bitstr" | ||
| 43 | .Fa "int bitnumber" | ||
| 44 | .Fc | ||
| 45 | .Ft int | ||
| 46 | .Fo ASN1_BIT_STRING_check | ||
| 47 | .Fa "ASN1_BIT_STRING *bitstr" | ||
| 48 | .Fa "const unsigned char *goodbits" | ||
| 49 | .Fa "int goodbits_len" | ||
| 50 | .Fc | ||
| 51 | .Sh DESCRIPTION | ||
| 52 | .Fn ASN1_BIT_STRING_set | ||
| 53 | sets the length attribute of | ||
| 54 | .Fa bitstr | ||
| 55 | to | ||
| 56 | .Fa len | ||
| 57 | and copies that number of bytes from | ||
| 58 | .Fa data | ||
| 59 | into | ||
| 60 | .Fa bitstr , | ||
| 61 | overwriting any previous data, by merely calling | ||
| 62 | .Xr ASN1_STRING_set 3 . | ||
| 63 | This function does no validation whatsoever. | ||
| 64 | In particular, it neither checks that | ||
| 65 | .Fa bitstr | ||
| 66 | is actually of the type | ||
| 67 | .Dv V_ASN1_BIT_STRING | ||
| 68 | nor, even if it is, that the | ||
| 69 | .Fa data | ||
| 70 | and | ||
| 71 | .Fa len | ||
| 72 | arguments make sense for this particular bit string. | ||
| 73 | .Pp | ||
| 74 | If the | ||
| 75 | .Fa set | ||
| 76 | argument is non-zero, | ||
| 77 | .Fn ASN1_BIT_STRING_set_bit | ||
| 78 | sets the bit with the given | ||
| 79 | .Fa bitnumber | ||
| 80 | in the | ||
| 81 | .Fa bitstr ; | ||
| 82 | otherwise, it clears that bit. | ||
| 83 | A | ||
| 84 | .Fa bitnumber | ||
| 85 | of 0 addresses the most significant bit in the first data byte of | ||
| 86 | .Fa bitstr , | ||
| 87 | 7 the least significant bit in the same byte, | ||
| 88 | 8 the most significant bit in the second data byte, and so on. | ||
| 89 | .Pp | ||
| 90 | If setting a bit is requested beyond the last existing data byte, | ||
| 91 | additional bytes are added to the | ||
| 92 | .Fa bitstr | ||
| 93 | as needed. | ||
| 94 | After clearing a bit, any trailing NUL bytes are removed from the | ||
| 95 | .Fa bitstr . | ||
| 96 | .Pp | ||
| 97 | .Fn ASN1_BIT_STRING_get_bit | ||
| 98 | checks that the bit with the given | ||
| 99 | .Fa bitnumber | ||
| 100 | is set in | ||
| 101 | .Fa bitstr . | ||
| 102 | .Pp | ||
| 103 | .Fn ASN1_BIT_STRING_check | ||
| 104 | checks that all bits set in | ||
| 105 | .Fa bitstr | ||
| 106 | are also set in | ||
| 107 | .Fa goodbits . | ||
| 108 | Expressed symbolically, it evaluates: | ||
| 109 | .Pp | ||
| 110 | .D1 Po Fa bitstr No & Pf \(ti Fa goodbits Pc == 0 | ||
| 111 | .Pp | ||
| 112 | The buffer | ||
| 113 | .Fa goodbits | ||
| 114 | is expected to contain | ||
| 115 | .Fa goodbits_len | ||
| 116 | bytes. | ||
| 117 | .Sh RETURN VALUES | ||
| 118 | .Fn ASN1_BIT_STRING_set | ||
| 119 | returns 1 on success or 0 if memory allocation fails or if | ||
| 120 | .Fa data | ||
| 121 | is | ||
| 122 | .Dv NULL | ||
| 123 | and | ||
| 124 | .Fa len | ||
| 125 | is \-1 in the same call. | ||
| 126 | .Pp | ||
| 127 | .Fn ASN1_BIT_STRING_set_bit | ||
| 128 | returns 1 on success or 0 if | ||
| 129 | .Fa bitstr | ||
| 130 | is | ||
| 131 | .Dv NULL | ||
| 132 | or if memory allocation fails. | ||
| 133 | .Pp | ||
| 134 | .Fn ASN1_BIT_STRING_get_bit | ||
| 135 | returns 1 if the bit with the given | ||
| 136 | .Fa bitnumber | ||
| 137 | is set in the | ||
| 138 | .Fa bitstr | ||
| 139 | or 0 if | ||
| 140 | .Fa bitstr | ||
| 141 | is | ||
| 142 | .Dv NULL , | ||
| 143 | if | ||
| 144 | .Fa bitnumber | ||
| 145 | points beyond the last data byte in | ||
| 146 | .Fa bitstr , | ||
| 147 | or if the requested bit is not set. | ||
| 148 | .Pp | ||
| 149 | .Fn ASN1_BIT_STRING_check | ||
| 150 | returns 0 | ||
| 151 | if at least one bit is set in | ||
| 152 | .Fa bitstr | ||
| 153 | that is not set in | ||
| 154 | .Fa goodbits , | ||
| 155 | or 1 otherwise. | ||
| 156 | In particular, it returns 1 if | ||
| 157 | .Fa bitstr | ||
| 158 | is | ||
| 159 | .Dv NULL | ||
| 160 | or if no bit is set in | ||
| 161 | .Fa bitstr . | ||
| 162 | .Sh SEE ALSO | ||
| 163 | .Xr ASN1_BIT_STRING_new 3 , | ||
| 164 | .Xr ASN1_STRING_set 3 , | ||
| 165 | .Xr d2i_ASN1_BIT_STRING 3 | ||
| 166 | .Sh HISTORY | ||
| 167 | .Fn ASN1_BIT_STRING_set | ||
| 168 | first appeared in SSLeay 0.6.5. | ||
| 169 | .Fn ASN1_BIT_STRING_set_bit | ||
| 170 | and | ||
| 171 | .Fn ASN1_BIT_STRING_get_bit | ||
| 172 | first appeared in SSLeay 0.9.0. | ||
| 173 | These functions have been available since | ||
| 174 | .Ox 2.4 . | ||
| 175 | .Pp | ||
| 176 | .Fn ASN1_BIT_STRING_check | ||
| 177 | first appeared in OpenSSL 1.0.0 and has have been available since | ||
| 178 | .Ox 4.9 . | ||
diff --git a/src/lib/libcrypto/man/ASN1_STRING_length.3 b/src/lib/libcrypto/man/ASN1_STRING_length.3 index 5a113ecb22..da0d7468c3 100644 --- a/src/lib/libcrypto/man/ASN1_STRING_length.3 +++ b/src/lib/libcrypto/man/ASN1_STRING_length.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: ASN1_STRING_length.3,v 1.25 2021/11/15 13:39:40 schwarze Exp $ | 1 | .\" $OpenBSD: ASN1_STRING_length.3,v 1.26 2021/11/15 16:18:36 schwarze Exp $ |
| 2 | .\" full merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100 | 2 | .\" full merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file is a derived work. | 4 | .\" This file is a derived work. |
| @@ -380,6 +380,7 @@ and | |||
| 380 | the reason can be determined with | 380 | the reason can be determined with |
| 381 | .Xr ERR_get_error 3 . | 381 | .Xr ERR_get_error 3 . |
| 382 | .Sh SEE ALSO | 382 | .Sh SEE ALSO |
| 383 | .Xr ASN1_BIT_STRING_set 3 , | ||
| 383 | .Xr ASN1_mbstring_copy 3 , | 384 | .Xr ASN1_mbstring_copy 3 , |
| 384 | .Xr ASN1_PRINTABLE_type 3 , | 385 | .Xr ASN1_PRINTABLE_type 3 , |
| 385 | .Xr ASN1_STRING_new 3 , | 386 | .Xr ASN1_STRING_new 3 , |
diff --git a/src/lib/libcrypto/man/ASN1_STRING_new.3 b/src/lib/libcrypto/man/ASN1_STRING_new.3 index 23679cdb3c..fbc999a325 100644 --- a/src/lib/libcrypto/man/ASN1_STRING_new.3 +++ b/src/lib/libcrypto/man/ASN1_STRING_new.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: ASN1_STRING_new.3,v 1.21 2021/11/15 13:39:40 schwarze Exp $ | 1 | .\" $OpenBSD: ASN1_STRING_new.3,v 1.22 2021/11/15 16:18:36 schwarze Exp $ |
| 2 | .\" OpenSSL 99d63d46 Tue Mar 24 07:52:24 2015 -0400 | 2 | .\" OpenSSL 99d63d46 Tue Mar 24 07:52:24 2015 -0400 |
| 3 | .\" | 3 | .\" |
| 4 | .\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org> | 4 | .\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org> |
| @@ -203,6 +203,7 @@ object if successful; otherwise | |||
| 203 | is returned and an error code can be retrieved with | 203 | is returned and an error code can be retrieved with |
| 204 | .Xr ERR_get_error 3 . | 204 | .Xr ERR_get_error 3 . |
| 205 | .Sh SEE ALSO | 205 | .Sh SEE ALSO |
| 206 | .Xr ASN1_BIT_STRING_set 3 , | ||
| 206 | .Xr ASN1_INTEGER_get 3 , | 207 | .Xr ASN1_INTEGER_get 3 , |
| 207 | .Xr ASN1_item_pack 3 , | 208 | .Xr ASN1_item_pack 3 , |
| 208 | .Xr ASN1_mbstring_copy 3 , | 209 | .Xr ASN1_mbstring_copy 3 , |
diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile index 2af6c16657..46ca3ba3d4 100644 --- a/src/lib/libcrypto/man/Makefile +++ b/src/lib/libcrypto/man/Makefile | |||
| @@ -1,10 +1,11 @@ | |||
| 1 | # $OpenBSD: Makefile,v 1.214 2021/11/15 13:39:40 schwarze Exp $ | 1 | # $OpenBSD: Makefile,v 1.215 2021/11/15 16:18:36 schwarze Exp $ |
| 2 | 2 | ||
| 3 | .include <bsd.own.mk> | 3 | .include <bsd.own.mk> |
| 4 | 4 | ||
| 5 | MAN= \ | 5 | MAN= \ |
| 6 | ACCESS_DESCRIPTION_new.3 \ | 6 | ACCESS_DESCRIPTION_new.3 \ |
| 7 | AES_encrypt.3 \ | 7 | AES_encrypt.3 \ |
| 8 | ASN1_BIT_STRING_set.3 \ | ||
| 8 | ASN1_INTEGER_get.3 \ | 9 | ASN1_INTEGER_get.3 \ |
| 9 | ASN1_OBJECT_new.3 \ | 10 | ASN1_OBJECT_new.3 \ |
| 10 | ASN1_PRINTABLE_type.3 \ | 11 | ASN1_PRINTABLE_type.3 \ |
