diff options
Diffstat (limited to 'src/lib/libcrypto/man/X509v3_addr_inherits.3')
-rw-r--r-- | src/lib/libcrypto/man/X509v3_addr_inherits.3 | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/X509v3_addr_inherits.3 b/src/lib/libcrypto/man/X509v3_addr_inherits.3 new file mode 100644 index 0000000000..a8465afb38 --- /dev/null +++ b/src/lib/libcrypto/man/X509v3_addr_inherits.3 | |||
@@ -0,0 +1,106 @@ | |||
1 | .\" $OpenBSD: X509v3_addr_inherits.3,v 1.1 2023/09/26 20:42:45 tb Exp $ | ||
2 | .\" | ||
3 | .\" Copyright (c) 2023 Theo Buehler <tb@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: September 26 2023 $ | ||
18 | .Dt X509V3_ADDR_INHERITS 3 | ||
19 | .Os | ||
20 | .Sh NAME | ||
21 | .Nm X509v3_addr_inherits , | ||
22 | .Nm X509v3_asid_inherits | ||
23 | .Nd inheritance for the IP address and AS number delegation extensions | ||
24 | .Sh SYNOPSIS | ||
25 | .In openssl/x509v3.h | ||
26 | .Ft int | ||
27 | .Fn X509v3_addr_inherits "IPAddrBlocks *addrblocks" | ||
28 | .Ft int | ||
29 | .Fn X509v3_asid_inherits "ASIdentifiers *asids" | ||
30 | .Sh DESCRIPTION | ||
31 | .Fn X509v3_addr_inherits | ||
32 | determines if there is at least one address family in | ||
33 | .Fa addrblocks | ||
34 | that uses inheritance. | ||
35 | .Pp | ||
36 | .Fn X509v3_asid_inherits | ||
37 | is intended to determine if at least one of | ||
38 | the list of autonomous system numbers or | ||
39 | the list of routing domain identifiers | ||
40 | uses inheritance. | ||
41 | .Sh RETURN VALUES | ||
42 | .Fn X509v3_addr_inherits | ||
43 | returns 1 if and only if | ||
44 | .Fa addrblocks | ||
45 | contains at least one | ||
46 | .Fa IPAddressFamily | ||
47 | object that is correctly marked | ||
48 | .Dq inherit : | ||
49 | its | ||
50 | .Fa IPAddressChoice | ||
51 | is of | ||
52 | .Fa type | ||
53 | .Dv IPAddressChoice_inherit | ||
54 | and its | ||
55 | .Fa inherit | ||
56 | element is present. | ||
57 | Otherwise it returns 0. | ||
58 | .Pp | ||
59 | .Fn X509v3_asid_inherits | ||
60 | returns 1 if and only if | ||
61 | at least one of the | ||
62 | .Fa asnum | ||
63 | or the | ||
64 | .Fa rdi | ||
65 | lists has | ||
66 | .Fa type | ||
67 | .Dv ASIdentifierChoice_inherit . | ||
68 | Otherwise | ||
69 | .Fn X509v3_asid_inherits 3 | ||
70 | returns 0. | ||
71 | .Sh SEE ALSO | ||
72 | .Xr ASIdentifiers_new 3 , | ||
73 | .Xr ASRange_new 3 , | ||
74 | .Xr crypto 3 , | ||
75 | .Xr IPAddressRange_new 3 , | ||
76 | .Xr X509_new 3 , | ||
77 | .Xr X509v3_addr_add_inherit 3 , | ||
78 | .Xr X509v3_asid_add_inherit 3 | ||
79 | .Sh STANDARDS | ||
80 | RFC 3779: X.509 Extensions for IP Addresses and AS Identifiers: | ||
81 | .Bl -dash -compact | ||
82 | .It | ||
83 | section 2: IP Address delegation extension | ||
84 | .It | ||
85 | section 2.2.3.5: Element inherit | ||
86 | .It | ||
87 | section 3: AS identifiers delegation extension | ||
88 | .It | ||
89 | section 3.2.3.3: Element inherit | ||
90 | .El | ||
91 | .Sh HISTORY | ||
92 | These functions first appeared in OpenSSL 0.9.8e | ||
93 | and have been available since | ||
94 | .Ox 7.1 . | ||
95 | .Sh BUGS | ||
96 | .Fn X509v3_asid_inherits | ||
97 | ignores whether the | ||
98 | .Fa inherit | ||
99 | is present or absent in the list that is considered to use inheritance. | ||
100 | .Pp | ||
101 | There is no API that determines whether all lists contained in an | ||
102 | .Vt ASIdentifiers | ||
103 | or an | ||
104 | .Vt IPAddrBlocks | ||
105 | objects inherit. | ||
106 | See RFC 9287, 5.1.2 for an example where this is relevant. | ||