11#ifndef BOTAN_PKIX_TYPES_H_
12#define BOTAN_PKIX_TYPES_H_
14#include <botan/asn1_obj.h>
16#include <botan/dns_name.h>
17#include <botan/email.h>
18#include <botan/ipv4_address.h>
19#include <botan/ipv6_address.h>
20#include <botan/pkix_enums.h>
23#include <initializer_list>
102 bool is_negative()
const;
107 bool is_zero()
const;
131 std::vector<uint8_t> magnitude()
const;
151 std::vector<uint8_t> m_contents;
161 X509_DN(std::initializer_list<std::pair<std::string_view, std::string_view>> args) {
162 for(
const auto& i : args) {
172 explicit
X509_DN(const std::multimap<
OID, std::
string>& args) {
173 for(
const auto& i : args) {
183 explicit
X509_DN(const std::multimap<std::
string, std::
string>& args) {
184 for(
const auto& i : args) {
192 bool has_field(
const OID& oid)
const;
198 const std::vector<uint8_t>&
get_bits()
const {
return m_dn_bits; }
200 std::vector<uint8_t> DER_encode()
const;
202 bool empty()
const {
return m_rdn.empty(); }
209 size_t count()
const {
return m_rdn.size(); }
222 static std::optional<X509_DN> parse(std::string_view str);
229 const std::vector<std::vector<std::pair<OID, ASN1_String>>>&
rdns()
const {
return m_rdn; }
238 std::multimap<
OID, std::
string> get_attributes() const;
239 std::multimap<std::
string, std::
string> contents() const;
241 bool has_field(std::string_view attr) const;
242 std::vector<std::
string> get_attribute(std::string_view attr) const;
243 std::
string get_first_attribute(std::string_view attr) const;
245 void add_attribute(std::string_view key, std::string_view val);
256 void add_rdn(std::vector<std::pair<OID, ASN1_String>> rdn);
258 static std::string deref_info_field(std::string_view key);
267 static size_t lookup_ub(
const OID& oid);
279 std::vector<std::vector<std::pair<OID, ASN1_String>>> m_rdn;
280 std::vector<uint8_t> m_dn_bits;
281 std::vector<uint8_t> m_canonical_dn_bits;
284BOTAN_PUBLIC_API(2, 0) bool operator==(const X509_DN& dn1, const X509_DN& dn2);
285BOTAN_PUBLIC_API(2, 0)
bool operator!=(const X509_DN& dn1, const X509_DN& dn2);
291BOTAN_PUBLIC_API(2, 0)
bool operator<(const X509_DN& dn1, const X509_DN& dn2);
293BOTAN_PUBLIC_API(2, 0) std::ostream& operator<<(std::ostream& out, const X509_DN& dn);
299BOTAN_DEPRECATED_API(
"Use X509_DN::parse") std::istream& operator>>(std::istream& in, X509_DN& dn);
307 class OtherNameValue final {
311 std::span<const uint8_t>
value()
const {
return m_value; }
314 if(
oid() != other.
oid()) {
315 return oid() < other.
oid();
317 return m_value < other.m_value;
323 OtherNameValue(
const OID&
oid, std::vector<uint8_t>
value) : m_oid(
oid), m_value(std::move(
value)) {}
326 m_oid(oid), m_value(value.begin(), value.end()) {}
329 std::vector<uint8_t> m_value;
332 void encode_into(DER_Encoder& to)
const override;
333 void decode_from(BER_Decoder& from)
override;
339 void add_uri(std::string_view uri);
386 BOTAN_DEPRECATED(
"Use AlternativeName::uri_names") std::set<std::
string> uris() const;
395 BOTAN_DEPRECATED(
"Use AlternativeName::email_addresses") std::set<std::
string> email() const;
404 BOTAN_DEPRECATED(
"Use AlternativeName::dns_names") std::set<std::
string> dns() const;
410 BOTAN_DEPRECATED(
"Use ipv4_addresses") std::set<uint32_t> ipv4_address() const;
447 size_t count()
const;
450 bool has_items()
const;
453 bool is_empty()
const;
456 BOTAN_DEPRECATED(
"Use AlternativeName::{uris, email, dns, othernames, directory_names}")
457 std::multimap<std::
string, std::
string> contents() const;
459 BOTAN_DEPRECATED(
"Use AlternativeName::{uris, email, dns, othernames, directory_names}.empty()")
460 bool has_field(std::string_view attr) const;
462 BOTAN_DEPRECATED(
"Use AlternativeName::{uris, email, dns, othernames, directory_names}")
463 std::vector<std::
string> get_attribute(std::string_view attr) const;
465 BOTAN_DEPRECATED(
"Use AlternativeName::{uris, email, dns, othernames, directory_names}")
466 std::multimap<std::
string, std::
string, std::less<>> get_attributes() const;
468 BOTAN_DEPRECATED(
"Use AlternativeName::{uris, email, dns, othernames, directory_names}")
469 std::
string get_first_attribute(std::string_view attr) const;
472 void add_attribute(std::string_view type, std::string_view value);
475 void add_othername(const
OID& oid, std::string_view value,
ASN1_Type type);
487 BOTAN_DEPRECATED(
"Use plain constructor plus add_{uri,dns,email,ipv4_address}")
489 std::string_view uri =
"",
490 std::string_view
dns =
"",
491 std::string_view ip_address =
"");
503 std::set<
OID> m_registered_ids;
516 Attribute(std::string_view oid_str,
const std::vector<uint8_t>& params);
520 const std::vector<uint8_t>&
parameters()
const {
return m_parameters; }
528 std::vector<uint8_t> m_parameters;
609 BOTAN_DEPRECATED(
"Deprecated no replacement") std::vector<uint8_t> binary_name() const;
618 bool matches_dns(const std::
string& dns_name) const;
619 bool matches_dns(const
DNSName& dns_name) const;
621 bool matches_ipv4(uint32_t ip) const;
626 bool matches_dn(
const X509_DN& dn)
const;
627 bool matches_uri(
const URI& uri)
const;
634 class EmailConstraint final {
636 EmailConstraint() =
default;
638 static std::optional<EmailConstraint> from_string(std::string_view input);
640 const std::string& value()
const {
return m_value; }
642 auto operator<=>(
const EmailConstraint&)
const =
default;
645 explicit EmailConstraint(std::string value) : m_value(std::move(value)) {}
650 class DNSConstraint final {
652 DNSConstraint() =
default;
654 static std::optional<DNSConstraint> from_string(std::string_view input);
656 static std::optional<DNSConstraint> from_san_value(std::string_view input);
658 const std::string& value()
const {
return m_value; }
660 auto operator<=>(
const DNSConstraint&)
const =
default;
663 explicit DNSConstraint(std::string value) : m_value(std::move(value)) {}
668 class URIConstraint final {
670 URIConstraint() =
default;
672 static std::optional<URIConstraint> from_string(std::string_view input);
674 static std::optional<URIConstraint> from_san_value(std::string_view full_uri);
676 const std::string& value()
const {
return m_value; }
678 auto operator<=>(
const URIConstraint&)
const =
default;
681 explicit URIConstraint(std::string value) : m_value(std::move(value)) {}
690 using NameVariant = std::variant<EmailConstraint, DNSConstraint, URIConstraint, X509_DN, IPv4Subnet, IPv6Subnet>;
692 GeneralName(NameType type, NameVariant
name) : m_type(type), m_name(std::move(
name)) {}
694 NameType m_type = NameType::Unknown;
701 static bool matches_dn(
const X509_DN&
name,
const X509_DN& constraint);
741BOTAN_DEPRECATED(
"Deprecated no replacement") std::ostream& operator<<(std::ostream& os, const GeneralSubtree& gs);
761 std::vector<GeneralSubtree>&& excluded_subtrees);
767 return m_permitted_subtrees;
774 return m_excluded_subtrees;
788 std::vector<GeneralSubtree> m_permitted_subtrees;
789 std::vector<GeneralSubtree> m_excluded_subtrees;
791 std::set<GeneralName::NameType> m_permitted_name_types;
792 std::set<GeneralName::NameType> m_excluded_name_types;
823 virtual std::unique_ptr<Certificate_Extension>
copy()
const = 0;
851 const std::optional<X509_Certificate>& issuer,
852 const std::vector<X509_Certificate>& cert_path,
853 std::vector<std::set<Certificate_Status_Code>>& cert_status,
881 template <
typename T>
885 if(extn->oid_name().empty()) {
887 }
else if(
const T* extn_as_T =
dynamic_cast<const T*
>(extn)) {
890 throw Decoding_Error(
"Exception::get_extension_object_as dynamic_cast failed");
907 std::vector<OID> critical_extensions()
const;
912 bool extension_set(
const OID& oid)
const;
917 bool critical_extension_set(
const OID& oid)
const;
923 std::vector<uint8_t> get_extension_bits(
const OID& oid)
const;
927 void decode_from(
BER_Decoder& from, std::optional<Extension_Context> context);
942 void add(std::unique_ptr<Certificate_Extension> extn,
bool critical =
false);
952 bool add_new(std::unique_ptr<Certificate_Extension> extn,
bool critical =
false);
959 void replace(std::unique_ptr<Certificate_Extension> extn,
bool critical =
false);
965 bool remove(
const OID& oid);
974 std::unique_ptr<Certificate_Extension> get(
const OID& oid)
const;
986 template <
typename T>
988 const auto extn_info = m_extension_info.find(oid);
990 if(extn_info != m_extension_info.end()) {
992 if(extn_info->second.obj().oid_name().empty()) {
993 auto ext = std::make_unique<T>();
994 ext->decode_inner(extn_info->second.bits());
1007 std::vector<std::pair<std::unique_ptr<Certificate_Extension>,
bool>> extensions()
const;
1013 const std::optional<X509_Certificate>& issuer,
1014 const std::vector<X509_Certificate>& cert_path,
1015 std::vector<std::set<Certificate_Status_Code>>& cert_status,
1023 std::map<OID, std::pair<std::vector<uint8_t>,
bool>> extensions_raw()
const;
1025 size_t count()
const {
return m_extension_oids.size(); }
1038 static std::unique_ptr<Certificate_Extension> create_extn_obj(
const OID& oid,
1040 const std::vector<uint8_t>& body,
1041 std::optional<Extension_Context> context);
1045 Extensions_Info(
bool critical, std::unique_ptr<Certificate_Extension> ext) :
1046 m_obj(std::move(ext)), m_bits(m_obj->encode_inner()), m_critical(critical) {}
1048 Extensions_Info(
bool critical, std::vector<uint8_t> encoding, std::unique_ptr<Certificate_Extension> ext) :
1049 m_obj(std::move(ext)), m_bits(std::move(encoding)), m_critical(critical) {}
1051 bool is_critical()
const {
return m_critical; }
1053 const std::vector<uint8_t>& bits()
const {
return m_bits; }
1055 const Certificate_Extension& obj()
const;
1058 std::shared_ptr<Certificate_Extension> m_obj;
1059 std::vector<uint8_t> m_bits;
1060 bool m_critical =
false;
1063 std::vector<OID> m_extension_oids;
1064 std::map<OID, Extensions_Info> m_extension_info;
1065 bool m_has_unknown_critical_extension =
false;
#define BOTAN_PUBLIC_API(maj, min)
#define BOTAN_UNSTABLE_API
#define BOTAN_DEPRECATED(msg)
#define BOTAN_FUTURE_EXPLICIT
#define BOTAN_DEPRECATED_API(msg)
An "OtherName" GeneralName entry: type-id OID and the inner ANY value as raw BER.
bool operator<(const OtherNameValue &other) const
std::span< const uint8_t > value() const
friend class AlternativeName
const std::set< IPv6Address > & ipv6_addresses() const
Return the set of IPv6 addresses included in this alternative name.
const std::set< DNSName > & dns_names() const
Return the set of DNS names included in this alternative name.
const std::set< X509_DN > & directory_names() const
Return the set of directory names included in this alternative name.
void add_dns(std::string_view dns)
Add a DNS name to this AlternativeName, parsing and validating the input.
std::set< std::string > dns() const
void add_ipv4_address(uint32_t ipv4)
Add an IP address to this alternative name.
void add_email(std::string_view addr)
Add an email address to this AlternativeName, parsing and validating the input.
const std::set< EmailAddress > & email_addresses() const
Return the set of email addresses included in this alternative name.
const std::set< std::pair< OID, ASN1_String > > & other_names() const
Return the set of "other names" whose value was a recognized ASN1_String type.
const std::set< SmtpUtf8Mailbox > & smtp_utf8_mailboxes() const
void add_uri(std::string_view uri)
Add a URI to this AlternativeName, parsing and validating the input.
void add_registered_id(const OID &oid)
Add a registeredID (RFC 5280 [8]).
const std::set< OtherNameValue > & other_name_values() const
Return all "OtherName" entries with their inner ANY value as raw BER.
void add_other_name_value(const OID &oid, std::span< const uint8_t > value)
void add_other_name(const OID &oid, const ASN1_String &value)
Add an "OtherName" identified by object identifier to this AlternativeName.
const std::set< IPv6Address > & ipv6_address() const
Return the set of IPv6 addresses included in this alternative name.
const std::set< IPv4Address > & ipv4_addresses() const
Return the set of IPv4 addresses included in this alternative name.
void add_dn(const X509_DN &dn)
Add a directory name to this AlternativeName.
const std::set< URI > & uri_names() const
Return the set of URIs included in this alternative name.
AlternativeName()=default
Create an empty name.
std::multimap< OID, ASN1_String > get_othernames() const
const std::set< OID > & registered_ids() const
Return the set of registeredID OIDs.
const std::vector< uint8_t > & parameters() const
void decode_from(BER_Decoder &from) override
const OID & object_identifier() const
void encode_into(DER_Encoder &to) const override
const std::vector< uint8_t > & get_parameters() const
virtual bool should_encode() const
virtual void validate(const X509_Certificate &subject, const std::optional< X509_Certificate > &issuer, const std::vector< X509_Certificate > &cert_path, std::vector< std::set< Certificate_Status_Code > > &cert_status, size_t pos) const
virtual std::string oid_name() const =0
virtual OID oid_of() const =0
virtual std::unique_ptr< Certificate_Extension > copy() const =0
virtual bool is_appropriate_context(Extension_Context context) const =0
virtual std::vector< uint8_t > encode_inner() const =0
virtual ~Certificate_Extension()=default
virtual void decode_inner(const std::vector< uint8_t > &)=0
const Certificate_Extension * get_extension_object(const OID &oid) const
std::unique_ptr< T > get_raw(const OID &oid) const
Extensions & operator=(const Extensions &)=default
bool has_unknown_critical_extension() const
Extensions(const Extensions &)=default
~Extensions() override=default
Extensions(Extensions &&)=default
const std::vector< OID > & get_extension_oids() const
const T * get_extension_object_as(const OID &oid=T::static_oid()) const
Extensions & operator=(Extensions &&)=default
static GeneralName email(std::string_view email)
void decode_from(BER_Decoder &from) override
static GeneralName ipv4_address(uint32_t ipv4)
void encode_into(DER_Encoder &to) const override
static GeneralName uri(std::string_view uri)
static GeneralName _dns_san_value(std::string_view dns)
static GeneralName ipv6_address(const IPv6Address &ipv6)
friend class NameConstraints
NameType type_code() const
bool matches_ipv4(const IPv4Address &ip) const
bool matches_ipv4(uint32_t ip) const
static GeneralName dns(std::string_view dns)
static GeneralName _uri_san_value(std::string_view full_uri)
static GeneralName directory_name(Botan::X509_DN dn)
A single Name Constraint.
const GeneralName & base() const
NameConstraints()=default
const std::vector< GeneralSubtree > & permitted() const
const std::vector< GeneralSubtree > & excluded() const
const std::vector< std::vector< std::pair< OID, ASN1_String > > > & rdns() const
void add_attribute(const OID &oid, std::string_view val)
void add_attribute(std::string_view key, std::string_view val)
const std::vector< uint8_t > & _canonical_bytes() const
X509_DN(std::initializer_list< std::pair< std::string_view, std::string_view > > args)
const std::vector< uint8_t > & get_bits() const
size_t octet_length() const
bool conforms_to_rfc5280() const
std::span< const uint8_t > der_contents() const
bool operator==(const X509_Serial_Number &other) const
auto operator<=>(const Strong< T, Tags... > &lhs, const Strong< T, Tags... > &rhs)
std::string to_string(ErrorType type)
Convert an ErrorType to string.
std::string key_constraints_to_string(Key_Constraints c)