Code
This commit is contained in:
@ -0,0 +1,38 @@
|
||||
"""
|
||||
Verify service identities.
|
||||
"""
|
||||
|
||||
from . import cryptography, hazmat, pyopenssl
|
||||
from .exceptions import (
|
||||
CertificateError,
|
||||
SubjectAltNameWarning,
|
||||
VerificationError,
|
||||
)
|
||||
|
||||
|
||||
__title__ = "service-identity"
|
||||
|
||||
__author__ = "Hynek Schlawack"
|
||||
|
||||
__license__ = "MIT"
|
||||
__copyright__ = "Copyright (c) 2014 " + __author__
|
||||
|
||||
|
||||
__all__ = [
|
||||
"CertificateError",
|
||||
"SubjectAltNameWarning",
|
||||
"VerificationError",
|
||||
"hazmat",
|
||||
"cryptography",
|
||||
"pyopenssl",
|
||||
]
|
||||
|
||||
|
||||
def __getattr__(name: str) -> str:
|
||||
if name != "__version__":
|
||||
msg = f"module {__name__} has no attribute {name}"
|
||||
raise AttributeError(msg)
|
||||
|
||||
from importlib.metadata import version
|
||||
|
||||
return version("service-identity")
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -0,0 +1,183 @@
|
||||
"""
|
||||
`cryptography.x509 <https://github.com/pyca/cryptography>`_-specific code.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import warnings
|
||||
|
||||
from typing import Sequence
|
||||
|
||||
from cryptography.x509 import (
|
||||
Certificate,
|
||||
DNSName,
|
||||
ExtensionOID,
|
||||
IPAddress,
|
||||
ObjectIdentifier,
|
||||
OtherName,
|
||||
UniformResourceIdentifier,
|
||||
)
|
||||
from cryptography.x509.extensions import ExtensionNotFound
|
||||
from pyasn1.codec.der.decoder import decode
|
||||
from pyasn1.type.char import IA5String
|
||||
|
||||
from .exceptions import CertificateError
|
||||
from .hazmat import (
|
||||
DNS_ID,
|
||||
CertificatePattern,
|
||||
DNSPattern,
|
||||
IPAddress_ID,
|
||||
IPAddressPattern,
|
||||
SRVPattern,
|
||||
URIPattern,
|
||||
verify_service_identity,
|
||||
)
|
||||
|
||||
|
||||
__all__ = ["verify_certificate_hostname"]
|
||||
|
||||
|
||||
def verify_certificate_hostname(
|
||||
certificate: Certificate, hostname: str
|
||||
) -> None:
|
||||
r"""
|
||||
Verify whether *certificate* is valid for *hostname*.
|
||||
|
||||
.. note::
|
||||
Nothing is verified about the *authority* of the certificate;
|
||||
the caller must verify that the certificate chains to an appropriate
|
||||
trust root themselves.
|
||||
|
||||
Args:
|
||||
certificate: A *cryptography* X509 certificate object.
|
||||
|
||||
hostname: The hostname that *certificate* should be valid for.
|
||||
|
||||
Raises:
|
||||
service_identity.VerificationError:
|
||||
If *certificate* is not valid for *hostname*.
|
||||
|
||||
service_identity.CertificateError:
|
||||
If *certificate* contains invalid / unexpected data. This includes
|
||||
the case where the certificate contains no `subjectAltName`\ s.
|
||||
|
||||
.. versionchanged:: 24.1.0
|
||||
:exc:`~service_identity.CertificateError` is raised if the certificate
|
||||
contains no ``subjectAltName``\ s instead of
|
||||
:exc:`~service_identity.VerificationError`.
|
||||
"""
|
||||
verify_service_identity(
|
||||
cert_patterns=extract_patterns(certificate),
|
||||
obligatory_ids=[DNS_ID(hostname)],
|
||||
optional_ids=[],
|
||||
)
|
||||
|
||||
|
||||
def verify_certificate_ip_address(
|
||||
certificate: Certificate, ip_address: str
|
||||
) -> None:
|
||||
r"""
|
||||
Verify whether *certificate* is valid for *ip_address*.
|
||||
|
||||
.. note::
|
||||
Nothing is verified about the *authority* of the certificate;
|
||||
the caller must verify that the certificate chains to an appropriate
|
||||
trust root themselves.
|
||||
|
||||
Args:
|
||||
certificate: A *cryptography* X509 certificate object.
|
||||
|
||||
ip_address:
|
||||
The IP address that *connection* should be valid for. Can be an
|
||||
IPv4 or IPv6 address.
|
||||
|
||||
Raises:
|
||||
service_identity.VerificationError:
|
||||
If *certificate* is not valid for *ip_address*.
|
||||
|
||||
service_identity.CertificateError:
|
||||
If *certificate* contains invalid / unexpected data. This includes
|
||||
the case where the certificate contains no ``subjectAltName``\ s.
|
||||
|
||||
.. versionadded:: 18.1.0
|
||||
|
||||
.. versionchanged:: 24.1.0
|
||||
:exc:`~service_identity.CertificateError` is raised if the certificate
|
||||
contains no ``subjectAltName``\ s instead of
|
||||
:exc:`~service_identity.VerificationError`.
|
||||
"""
|
||||
verify_service_identity(
|
||||
cert_patterns=extract_patterns(certificate),
|
||||
obligatory_ids=[IPAddress_ID(ip_address)],
|
||||
optional_ids=[],
|
||||
)
|
||||
|
||||
|
||||
ID_ON_DNS_SRV = ObjectIdentifier("1.3.6.1.5.5.7.8.7") # id_on_dnsSRV
|
||||
|
||||
|
||||
def extract_patterns(cert: Certificate) -> Sequence[CertificatePattern]:
|
||||
"""
|
||||
Extract all valid ID patterns from a certificate for service verification.
|
||||
|
||||
Args:
|
||||
cert: The certificate to be dissected.
|
||||
|
||||
Returns:
|
||||
List of IDs.
|
||||
|
||||
.. versionchanged:: 23.1.0
|
||||
``commonName`` is not used as a fallback anymore.
|
||||
"""
|
||||
ids: list[CertificatePattern] = []
|
||||
try:
|
||||
ext = cert.extensions.get_extension_for_oid(
|
||||
ExtensionOID.SUBJECT_ALTERNATIVE_NAME
|
||||
)
|
||||
except ExtensionNotFound:
|
||||
pass
|
||||
else:
|
||||
ids.extend(
|
||||
[
|
||||
DNSPattern.from_bytes(name.encode("utf-8"))
|
||||
for name in ext.value.get_values_for_type(DNSName)
|
||||
]
|
||||
)
|
||||
ids.extend(
|
||||
[
|
||||
URIPattern.from_bytes(uri.encode("utf-8"))
|
||||
for uri in ext.value.get_values_for_type(
|
||||
UniformResourceIdentifier
|
||||
)
|
||||
]
|
||||
)
|
||||
ids.extend(
|
||||
[
|
||||
IPAddressPattern(ip)
|
||||
for ip in ext.value.get_values_for_type(IPAddress)
|
||||
]
|
||||
)
|
||||
for other in ext.value.get_values_for_type(OtherName):
|
||||
if other.type_id == ID_ON_DNS_SRV:
|
||||
srv, _ = decode(other.value)
|
||||
if isinstance(srv, IA5String):
|
||||
ids.append(SRVPattern.from_bytes(srv.asOctets()))
|
||||
else: # pragma: no cover
|
||||
msg = "Unexpected certificate content."
|
||||
raise CertificateError(msg)
|
||||
|
||||
return ids
|
||||
|
||||
|
||||
def extract_ids(cert: Certificate) -> Sequence[CertificatePattern]:
|
||||
"""
|
||||
Deprecated and never public API. Use :func:`extract_patterns` instead.
|
||||
|
||||
.. deprecated:: 23.1.0
|
||||
"""
|
||||
warnings.warn(
|
||||
category=DeprecationWarning,
|
||||
message="`extract_ids()` is deprecated, please use `extract_patterns()`.",
|
||||
stacklevel=2,
|
||||
)
|
||||
return extract_patterns(cert)
|
||||
@ -0,0 +1,80 @@
|
||||
"""
|
||||
All exceptions and warnings thrown by ``service-identity``.
|
||||
|
||||
Separated into an own package for nicer tracebacks, you should still import
|
||||
them from __init__.py.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import TYPE_CHECKING, Sequence
|
||||
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .hazmat import ServiceID
|
||||
|
||||
import attr
|
||||
|
||||
|
||||
class SubjectAltNameWarning(DeprecationWarning):
|
||||
"""
|
||||
This warning is not used anymore and will be removed in a future version.
|
||||
|
||||
Formerly:
|
||||
|
||||
Server Certificate does not contain a ``SubjectAltName``.
|
||||
|
||||
Hostname matching is performed on the ``CommonName`` which is deprecated.
|
||||
|
||||
.. deprecated:: 23.1.0
|
||||
"""
|
||||
|
||||
|
||||
@attr.s(slots=True)
|
||||
class Mismatch:
|
||||
mismatched_id: ServiceID = attr.ib()
|
||||
|
||||
|
||||
class DNSMismatch(Mismatch):
|
||||
"""
|
||||
No matching DNSPattern could be found.
|
||||
"""
|
||||
|
||||
|
||||
class SRVMismatch(Mismatch):
|
||||
"""
|
||||
No matching SRVPattern could be found.
|
||||
"""
|
||||
|
||||
|
||||
class URIMismatch(Mismatch):
|
||||
"""
|
||||
No matching URIPattern could be found.
|
||||
"""
|
||||
|
||||
|
||||
class IPAddressMismatch(Mismatch):
|
||||
"""
|
||||
No matching IPAddressPattern could be found.
|
||||
"""
|
||||
|
||||
|
||||
@attr.s(auto_exc=True)
|
||||
class VerificationError(Exception):
|
||||
"""
|
||||
Service identity verification failed.
|
||||
"""
|
||||
|
||||
errors: Sequence[Mismatch] = attr.ib()
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.__repr__()
|
||||
|
||||
|
||||
class CertificateError(Exception):
|
||||
r"""
|
||||
Certificate contains invalid or unexpected data.
|
||||
|
||||
This includes the case where s certificate contains no
|
||||
``subjectAltName``\ s.
|
||||
"""
|
||||
@ -0,0 +1,468 @@
|
||||
"""
|
||||
Common verification code.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import ipaddress
|
||||
import re
|
||||
|
||||
from typing import Protocol, Sequence, Union, runtime_checkable
|
||||
|
||||
import attr
|
||||
|
||||
from .exceptions import (
|
||||
CertificateError,
|
||||
DNSMismatch,
|
||||
IPAddressMismatch,
|
||||
Mismatch,
|
||||
SRVMismatch,
|
||||
URIMismatch,
|
||||
VerificationError,
|
||||
)
|
||||
|
||||
|
||||
try:
|
||||
import idna
|
||||
except ImportError:
|
||||
idna = None # type: ignore[assignment]
|
||||
|
||||
|
||||
@attr.s(slots=True)
|
||||
class ServiceMatch:
|
||||
"""
|
||||
A match of a service id and a certificate pattern.
|
||||
"""
|
||||
|
||||
service_id: ServiceID = attr.ib()
|
||||
cert_pattern: CertificatePattern = attr.ib()
|
||||
|
||||
|
||||
def verify_service_identity(
|
||||
cert_patterns: Sequence[CertificatePattern],
|
||||
obligatory_ids: Sequence[ServiceID],
|
||||
optional_ids: Sequence[ServiceID],
|
||||
) -> list[ServiceMatch]:
|
||||
"""
|
||||
Verify whether *cert_patterns* are valid for *obligatory_ids* and
|
||||
*optional_ids*.
|
||||
|
||||
*obligatory_ids* must be both present and match. *optional_ids* must match
|
||||
if a pattern of the respective type is present.
|
||||
"""
|
||||
if not cert_patterns:
|
||||
msg = "Certificate does not contain any `subjectAltName`s."
|
||||
raise CertificateError(msg)
|
||||
|
||||
errors = []
|
||||
matches = _find_matches(cert_patterns, obligatory_ids) + _find_matches(
|
||||
cert_patterns, optional_ids
|
||||
)
|
||||
|
||||
matched_ids = [match.service_id for match in matches]
|
||||
for i in obligatory_ids:
|
||||
if i not in matched_ids:
|
||||
errors.append( # noqa: PERF401
|
||||
i.error_on_mismatch(mismatched_id=i)
|
||||
)
|
||||
|
||||
for i in optional_ids:
|
||||
# If an optional ID is not matched by a certificate pattern *but* there
|
||||
# is a pattern of the same type , it is an error and the verification
|
||||
# fails. Example: the user passes a SRV-ID for "_mail.domain.com" but
|
||||
# the certificate contains an SRV-Pattern for "_xmpp.domain.com".
|
||||
if i not in matched_ids and _contains_instance_of(
|
||||
cert_patterns, i.pattern_class
|
||||
):
|
||||
errors.append( # noqa: PERF401
|
||||
i.error_on_mismatch(mismatched_id=i)
|
||||
)
|
||||
|
||||
if errors:
|
||||
raise VerificationError(errors=errors)
|
||||
|
||||
return matches
|
||||
|
||||
|
||||
def _find_matches(
|
||||
cert_patterns: Sequence[CertificatePattern],
|
||||
service_ids: Sequence[ServiceID],
|
||||
) -> list[ServiceMatch]:
|
||||
"""
|
||||
Search for matching certificate patterns and service_ids.
|
||||
|
||||
Args:
|
||||
service_ids: List of service IDs like DNS_ID.
|
||||
"""
|
||||
matches = []
|
||||
for sid in service_ids:
|
||||
for cid in cert_patterns:
|
||||
if sid.verify(cid):
|
||||
matches.append( # noqa: PERF401
|
||||
ServiceMatch(cert_pattern=cid, service_id=sid)
|
||||
)
|
||||
|
||||
return matches
|
||||
|
||||
|
||||
def _contains_instance_of(seq: Sequence[object], cl: type) -> bool:
|
||||
return any(isinstance(e, cl) for e in seq)
|
||||
|
||||
|
||||
def _is_ip_address(pattern: str | bytes) -> bool:
|
||||
"""
|
||||
Check whether *pattern* could be/match an IP address.
|
||||
|
||||
Args:
|
||||
pattern: A pattern for a host name.
|
||||
|
||||
Returns:
|
||||
`True` if *pattern* could be an IP address, else `False`.
|
||||
"""
|
||||
if isinstance(pattern, bytes):
|
||||
try:
|
||||
pattern = pattern.decode("ascii")
|
||||
except UnicodeError:
|
||||
return False
|
||||
|
||||
try:
|
||||
int(pattern)
|
||||
except ValueError:
|
||||
pass
|
||||
else:
|
||||
return True
|
||||
|
||||
try:
|
||||
ipaddress.ip_address(pattern.replace("*", "1"))
|
||||
except ValueError:
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
@attr.s(slots=True)
|
||||
class DNSPattern:
|
||||
"""
|
||||
A DNS pattern as extracted from certificates.
|
||||
"""
|
||||
|
||||
#: The pattern.
|
||||
pattern: bytes = attr.ib()
|
||||
|
||||
_RE_LEGAL_CHARS = re.compile(rb"^[a-z0-9\-_.]+$")
|
||||
|
||||
@classmethod
|
||||
def from_bytes(cls, pattern: bytes) -> DNSPattern:
|
||||
if not isinstance(pattern, bytes):
|
||||
msg = "The DNS pattern must be a bytes string."
|
||||
raise TypeError(msg)
|
||||
|
||||
pattern = pattern.strip()
|
||||
|
||||
if pattern == b"" or _is_ip_address(pattern) or b"\0" in pattern:
|
||||
msg = f"Invalid DNS pattern {pattern!r}."
|
||||
raise CertificateError(msg)
|
||||
|
||||
pattern = pattern.translate(_TRANS_TO_LOWER)
|
||||
if b"*" in pattern:
|
||||
_validate_pattern(pattern)
|
||||
|
||||
return cls(pattern=pattern)
|
||||
|
||||
|
||||
@attr.s(slots=True)
|
||||
class IPAddressPattern:
|
||||
"""
|
||||
An IP address pattern as extracted from certificates.
|
||||
"""
|
||||
|
||||
#: The pattern.
|
||||
pattern: ipaddress.IPv4Address | ipaddress.IPv6Address = attr.ib()
|
||||
|
||||
@classmethod
|
||||
def from_bytes(cls, bs: bytes) -> IPAddressPattern:
|
||||
try:
|
||||
return cls(pattern=ipaddress.ip_address(bs))
|
||||
except ValueError:
|
||||
msg = f"Invalid IP address pattern {bs!r}."
|
||||
raise CertificateError(msg) from None
|
||||
|
||||
|
||||
@attr.s(slots=True)
|
||||
class URIPattern:
|
||||
"""
|
||||
An URI pattern as extracted from certificates.
|
||||
"""
|
||||
|
||||
#: The pattern for the protocol part.
|
||||
protocol_pattern: bytes = attr.ib()
|
||||
#: The pattern for the DNS part.
|
||||
dns_pattern: DNSPattern = attr.ib()
|
||||
|
||||
@classmethod
|
||||
def from_bytes(cls, pattern: bytes) -> URIPattern:
|
||||
if not isinstance(pattern, bytes):
|
||||
msg = "The URI pattern must be a bytes string."
|
||||
raise TypeError(msg)
|
||||
|
||||
pattern = pattern.strip().translate(_TRANS_TO_LOWER)
|
||||
|
||||
if b":" not in pattern or b"*" in pattern or _is_ip_address(pattern):
|
||||
msg = f"Invalid URI pattern {pattern!r}."
|
||||
raise CertificateError(msg)
|
||||
|
||||
protocol_pattern, hostname = pattern.split(b":")
|
||||
|
||||
return cls(
|
||||
protocol_pattern=protocol_pattern,
|
||||
dns_pattern=DNSPattern.from_bytes(hostname),
|
||||
)
|
||||
|
||||
|
||||
@attr.s(slots=True)
|
||||
class SRVPattern:
|
||||
"""
|
||||
An SRV pattern as extracted from certificates.
|
||||
"""
|
||||
|
||||
#: The pattern for the name part.
|
||||
name_pattern: bytes = attr.ib()
|
||||
#: The pattern for the DNS part.
|
||||
dns_pattern: DNSPattern = attr.ib()
|
||||
|
||||
@classmethod
|
||||
def from_bytes(cls, pattern: bytes) -> SRVPattern:
|
||||
if not isinstance(pattern, bytes):
|
||||
msg = "The SRV pattern must be a bytes string."
|
||||
raise TypeError(msg)
|
||||
|
||||
pattern = pattern.strip().translate(_TRANS_TO_LOWER)
|
||||
|
||||
if (
|
||||
pattern[0] != b"_"[0]
|
||||
or b"." not in pattern
|
||||
or b"*" in pattern
|
||||
or _is_ip_address(pattern)
|
||||
):
|
||||
msg = f"Invalid SRV pattern {pattern!r}."
|
||||
raise CertificateError(msg)
|
||||
|
||||
name, hostname = pattern.split(b".", 1)
|
||||
return cls(
|
||||
name_pattern=name[1:], dns_pattern=DNSPattern.from_bytes(hostname)
|
||||
)
|
||||
|
||||
|
||||
CertificatePattern = Union[
|
||||
SRVPattern, URIPattern, DNSPattern, IPAddressPattern
|
||||
]
|
||||
"""
|
||||
A :class:`Union` of all possible patterns that can be extracted from a
|
||||
certificate.
|
||||
"""
|
||||
|
||||
|
||||
@runtime_checkable
|
||||
class ServiceID(Protocol):
|
||||
@property
|
||||
def pattern_class(self) -> type[CertificatePattern]: ...
|
||||
|
||||
@property
|
||||
def error_on_mismatch(self) -> type[Mismatch]: ...
|
||||
|
||||
def verify(self, pattern: CertificatePattern) -> bool: ...
|
||||
|
||||
|
||||
@attr.s(init=False, slots=True)
|
||||
class DNS_ID:
|
||||
"""
|
||||
A DNS service ID, aka hostname.
|
||||
"""
|
||||
|
||||
hostname: bytes = attr.ib()
|
||||
|
||||
# characters that are legal in a normalized hostname
|
||||
_RE_LEGAL_CHARS = re.compile(rb"^[a-z0-9\-_.]+$")
|
||||
pattern_class = DNSPattern
|
||||
error_on_mismatch = DNSMismatch
|
||||
|
||||
def __init__(self, hostname: str):
|
||||
if not isinstance(hostname, str):
|
||||
msg = "DNS-ID must be a text string."
|
||||
raise TypeError(msg)
|
||||
|
||||
hostname = hostname.strip()
|
||||
if not hostname or _is_ip_address(hostname):
|
||||
msg = "Invalid DNS-ID."
|
||||
raise ValueError(msg)
|
||||
|
||||
if any(ord(c) > 127 for c in hostname):
|
||||
if idna:
|
||||
ascii_id = idna.encode(hostname)
|
||||
else:
|
||||
msg = "idna library is required for non-ASCII IDs."
|
||||
raise ImportError(msg)
|
||||
else:
|
||||
ascii_id = hostname.encode("ascii")
|
||||
|
||||
self.hostname = ascii_id.translate(_TRANS_TO_LOWER)
|
||||
if self._RE_LEGAL_CHARS.match(self.hostname) is None:
|
||||
msg = "Invalid DNS-ID."
|
||||
raise ValueError(msg)
|
||||
|
||||
def verify(self, pattern: CertificatePattern) -> bool:
|
||||
"""
|
||||
https://tools.ietf.org/search/rfc6125#section-6.4
|
||||
"""
|
||||
if isinstance(pattern, self.pattern_class):
|
||||
return _hostname_matches(pattern.pattern, self.hostname)
|
||||
|
||||
return False
|
||||
|
||||
|
||||
@attr.s(slots=True)
|
||||
class IPAddress_ID:
|
||||
"""
|
||||
An IP address service ID.
|
||||
"""
|
||||
|
||||
ip: ipaddress.IPv4Address | ipaddress.IPv6Address = attr.ib(
|
||||
converter=ipaddress.ip_address
|
||||
)
|
||||
|
||||
pattern_class = IPAddressPattern
|
||||
error_on_mismatch = IPAddressMismatch
|
||||
|
||||
def verify(self, pattern: CertificatePattern) -> bool:
|
||||
"""
|
||||
https://tools.ietf.org/search/rfc2818#section-3.1
|
||||
"""
|
||||
if isinstance(pattern, self.pattern_class):
|
||||
return self.ip == pattern.pattern
|
||||
|
||||
return False
|
||||
|
||||
|
||||
@attr.s(init=False, slots=True)
|
||||
class URI_ID:
|
||||
"""
|
||||
An URI service ID.
|
||||
"""
|
||||
|
||||
protocol: bytes = attr.ib()
|
||||
dns_id: DNS_ID = attr.ib()
|
||||
|
||||
pattern_class = URIPattern
|
||||
error_on_mismatch = URIMismatch
|
||||
|
||||
def __init__(self, uri: str):
|
||||
if not isinstance(uri, str):
|
||||
msg = "URI-ID must be a text string."
|
||||
raise TypeError(msg)
|
||||
|
||||
uri = uri.strip()
|
||||
if ":" not in uri or _is_ip_address(uri):
|
||||
msg = "Invalid URI-ID."
|
||||
raise ValueError(msg)
|
||||
|
||||
prot, hostname = uri.split(":")
|
||||
|
||||
self.protocol = prot.encode("ascii").translate(_TRANS_TO_LOWER)
|
||||
self.dns_id = DNS_ID(hostname.strip("/"))
|
||||
|
||||
def verify(self, pattern: CertificatePattern) -> bool:
|
||||
"""
|
||||
https://tools.ietf.org/search/rfc6125#section-6.5.2
|
||||
"""
|
||||
if isinstance(pattern, self.pattern_class):
|
||||
return (
|
||||
pattern.protocol_pattern == self.protocol
|
||||
and self.dns_id.verify(pattern.dns_pattern)
|
||||
)
|
||||
|
||||
return False
|
||||
|
||||
|
||||
@attr.s(init=False, slots=True)
|
||||
class SRV_ID:
|
||||
"""
|
||||
An SRV service ID.
|
||||
"""
|
||||
|
||||
name: bytes = attr.ib()
|
||||
dns_id: DNS_ID = attr.ib()
|
||||
|
||||
pattern_class = SRVPattern
|
||||
error_on_mismatch = SRVMismatch
|
||||
|
||||
def __init__(self, srv: str):
|
||||
if not isinstance(srv, str):
|
||||
msg = "SRV-ID must be a text string."
|
||||
raise TypeError(msg)
|
||||
|
||||
srv = srv.strip()
|
||||
if "." not in srv or _is_ip_address(srv) or srv[0] != "_":
|
||||
msg = "Invalid SRV-ID."
|
||||
raise ValueError(msg)
|
||||
|
||||
name, hostname = srv.split(".", 1)
|
||||
|
||||
self.name = name[1:].encode("ascii").translate(_TRANS_TO_LOWER)
|
||||
self.dns_id = DNS_ID(hostname)
|
||||
|
||||
def verify(self, pattern: CertificatePattern) -> bool:
|
||||
"""
|
||||
https://tools.ietf.org/search/rfc6125#section-6.5.1
|
||||
"""
|
||||
if isinstance(pattern, self.pattern_class):
|
||||
return self.name == pattern.name_pattern and self.dns_id.verify(
|
||||
pattern.dns_pattern
|
||||
)
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def _hostname_matches(cert_pattern: bytes, actual_hostname: bytes) -> bool:
|
||||
"""
|
||||
:return: `True` if *cert_pattern* matches *actual_hostname*, else `False`.
|
||||
"""
|
||||
if b"*" in cert_pattern:
|
||||
cert_head, cert_tail = cert_pattern.split(b".", 1)
|
||||
actual_head, actual_tail = actual_hostname.split(b".", 1)
|
||||
if cert_tail != actual_tail:
|
||||
return False
|
||||
# No patterns for IDNA
|
||||
if actual_head.startswith(b"xn--"):
|
||||
return False
|
||||
|
||||
return cert_head in (b"*", actual_head)
|
||||
|
||||
return cert_pattern == actual_hostname
|
||||
|
||||
|
||||
def _validate_pattern(cert_pattern: bytes) -> None:
|
||||
"""
|
||||
Check whether the usage of wildcards within *cert_pattern* conforms with
|
||||
our expectations.
|
||||
"""
|
||||
cnt = cert_pattern.count(b"*")
|
||||
if cnt > 1:
|
||||
msg = f"Certificate's DNS-ID {cert_pattern!r} contains too many wildcards."
|
||||
raise CertificateError(msg)
|
||||
parts = cert_pattern.split(b".")
|
||||
if len(parts) < 3:
|
||||
msg = f"Certificate's DNS-ID {cert_pattern!r} has too few host components for wildcard usage."
|
||||
raise CertificateError(msg)
|
||||
# We assume there will always be only one wildcard allowed.
|
||||
if b"*" not in parts[0]:
|
||||
msg = f"Certificate's DNS-ID {cert_pattern!r} has a wildcard outside the left-most part."
|
||||
raise CertificateError(msg)
|
||||
if any(not len(p) for p in parts):
|
||||
msg = f"Certificate's DNS-ID {cert_pattern!r} contains empty parts."
|
||||
raise CertificateError(msg)
|
||||
|
||||
|
||||
# Ensure no locale magic interferes.
|
||||
_TRANS_TO_LOWER = bytes.maketrans(
|
||||
b"ABCDEFGHIJKLMNOPQRSTUVWXYZ", b"abcdefghijklmnopqrstuvwxyz"
|
||||
)
|
||||
@ -0,0 +1,126 @@
|
||||
"""
|
||||
`pyOpenSSL <https://github.com/pyca/pyopenssl>`_-specific code.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import contextlib
|
||||
import warnings
|
||||
|
||||
from typing import Sequence
|
||||
|
||||
from .cryptography import extract_patterns as _cryptography_extract_patterns
|
||||
from .hazmat import (
|
||||
DNS_ID,
|
||||
CertificatePattern,
|
||||
IPAddress_ID,
|
||||
verify_service_identity,
|
||||
)
|
||||
|
||||
|
||||
with contextlib.suppress(ImportError):
|
||||
# We only use it for docstrings -- `if TYPE_CHECKING`` does not work.
|
||||
from OpenSSL.crypto import X509
|
||||
from OpenSSL.SSL import Connection
|
||||
|
||||
|
||||
__all__ = ["verify_hostname"]
|
||||
|
||||
|
||||
def verify_hostname(connection: Connection, hostname: str) -> None:
|
||||
r"""
|
||||
Verify whether the certificate of *connection* is valid for *hostname*.
|
||||
|
||||
Args:
|
||||
connection: A pyOpenSSL connection object.
|
||||
|
||||
hostname: The hostname that *connection* should be connected to.
|
||||
|
||||
Raises:
|
||||
service_identity.VerificationError:
|
||||
If *connection* does not provide a certificate that is valid for
|
||||
*hostname*.
|
||||
|
||||
service_identity.CertificateError:
|
||||
If certificate provided by *connection* contains invalid /
|
||||
unexpected data. This includes the case where the certificate
|
||||
contains no ``subjectAltName``\ s.
|
||||
|
||||
.. versionchanged:: 24.1.0
|
||||
:exc:`~service_identity.CertificateError` is raised if the certificate
|
||||
contains no ``subjectAltName``\ s instead of
|
||||
:exc:`~service_identity.VerificationError`.
|
||||
"""
|
||||
verify_service_identity(
|
||||
cert_patterns=extract_patterns(
|
||||
connection.get_peer_certificate() # type:ignore[arg-type]
|
||||
),
|
||||
obligatory_ids=[DNS_ID(hostname)],
|
||||
optional_ids=[],
|
||||
)
|
||||
|
||||
|
||||
def verify_ip_address(connection: Connection, ip_address: str) -> None:
|
||||
r"""
|
||||
Verify whether the certificate of *connection* is valid for *ip_address*.
|
||||
|
||||
Args:
|
||||
connection: A pyOpenSSL connection object.
|
||||
|
||||
ip_address:
|
||||
The IP address that *connection* should be connected to. Can be an
|
||||
IPv4 or IPv6 address.
|
||||
|
||||
Raises:
|
||||
service_identity.VerificationError:
|
||||
If *connection* does not provide a certificate that is valid for
|
||||
*ip_address*.
|
||||
|
||||
service_identity.CertificateError:
|
||||
If the certificate chain of *connection* contains a certificate
|
||||
that contains invalid/unexpected data.
|
||||
|
||||
.. versionadded:: 18.1.0
|
||||
|
||||
.. versionchanged:: 24.1.0
|
||||
:exc:`~service_identity.CertificateError` is raised if the certificate
|
||||
contains no ``subjectAltName``\ s instead of
|
||||
:exc:`~service_identity.VerificationError`.
|
||||
"""
|
||||
verify_service_identity(
|
||||
cert_patterns=extract_patterns(
|
||||
connection.get_peer_certificate() # type:ignore[arg-type]
|
||||
),
|
||||
obligatory_ids=[IPAddress_ID(ip_address)],
|
||||
optional_ids=[],
|
||||
)
|
||||
|
||||
|
||||
def extract_patterns(cert: X509) -> Sequence[CertificatePattern]:
|
||||
"""
|
||||
Extract all valid ID patterns from a certificate for service verification.
|
||||
|
||||
Args:
|
||||
cert: The certificate to be dissected.
|
||||
|
||||
Returns:
|
||||
List of IDs.
|
||||
|
||||
.. versionchanged:: 23.1.0
|
||||
``commonName`` is not used as a fallback anymore.
|
||||
"""
|
||||
return _cryptography_extract_patterns(cert.to_cryptography())
|
||||
|
||||
|
||||
def extract_ids(cert: X509) -> Sequence[CertificatePattern]:
|
||||
"""
|
||||
Deprecated and never public API. Use :func:`extract_patterns` instead.
|
||||
|
||||
.. deprecated:: 23.1.0
|
||||
"""
|
||||
warnings.warn(
|
||||
category=DeprecationWarning,
|
||||
message="`extract_ids()` is deprecated, please use `extract_patterns()`.",
|
||||
stacklevel=2,
|
||||
)
|
||||
return extract_patterns(cert)
|
||||
Reference in New Issue
Block a user