feat: support in-memory PEM cert/key alongside file paths in DtlsCoapSession
localthings mints its client cert at runtime through the HA config flow and never writes it to disk. DtlsCoapSession only accepted cert_path/ key_path (file-based), which would have forced localthings to write its in-memory cert/key to disk on every connect just to migrate off its vendored copy of this transport layer. Adds an alternate cert_pem/key_pem constructor path (ported from localthings' own _load_pem_chain), validated so exactly one cert source (file pair or PEM pair) is required. Existing file-path callers (mqtt_demo, setup_cert.py) are unaffected — verified against both real appliances with each constructor path.
This commit is contained in:
1 parent
3fdc735141
commit
a2dc524c0b
2 files changed
+113
-7
No files matched your search
@@ -19,6 +19,7 @@ on a per-token Event the reader signals. OBSERVE notifications are
|
|||||||
delivered via the on_notification callback.
|
delivered via the on_notification callback.
|
||||||
"""
|
"""
|
||||||
import os
|
import os
|
||||||
|
import re as _re
|
||||||
import socket
|
import socket
|
||||||
import threading
|
import threading
|
||||||
import time
|
import time
|
||||||
@@ -61,31 +62,75 @@ _BLOCK_ACK_TIMEOUT = 4.0
|
|||||||
# once the ceiling is measured empirically.
|
# once the ceiling is measured empirically.
|
||||||
_DEFAULT_RATE_LIMIT_RPS = 5.0
|
_DEFAULT_RATE_LIMIT_RPS = 5.0
|
||||||
|
|
||||||
|
_PEM_CERT_RE = _re.compile(
|
||||||
|
rb'-----BEGIN CERTIFICATE-----.*?-----END CERTIFICATE-----',
|
||||||
|
_re.DOTALL,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _load_pem_chain(ctx: SSL.Context, cert_pem: str, key_pem: str) -> None:
|
||||||
|
"""Load a PEM cert chain and private key into an SSL context in memory.
|
||||||
|
|
||||||
|
Parses all certificate blocks from cert_pem: the first is the leaf
|
||||||
|
(use_certificate), the rest are intermediates (add_extra_chain_cert).
|
||||||
|
No temp files are written.
|
||||||
|
"""
|
||||||
|
from OpenSSL import crypto
|
||||||
|
certs = _PEM_CERT_RE.findall(cert_pem.encode())
|
||||||
|
if not certs:
|
||||||
|
raise ValueError("No certificates found in cert_pem")
|
||||||
|
ctx.use_certificate(crypto.load_certificate(crypto.FILETYPE_PEM, certs[0]))
|
||||||
|
for extra in certs[1:]:
|
||||||
|
ctx.add_extra_chain_cert(
|
||||||
|
crypto.load_certificate(crypto.FILETYPE_PEM, extra)
|
||||||
|
)
|
||||||
|
ctx.use_privatekey(crypto.load_privatekey(crypto.FILETYPE_PEM, key_pem.encode()))
|
||||||
|
ctx.check_privatekey()
|
||||||
|
|
||||||
|
|
||||||
class DtlsCoapSession:
|
class DtlsCoapSession:
|
||||||
"""Single sustained DTLS-CoAP session.
|
"""Single sustained DTLS-CoAP session.
|
||||||
|
|
||||||
Caller drives lifecycle:
|
Caller drives lifecycle:
|
||||||
sess = DtlsCoapSession(host, port, cert, key)
|
sess = DtlsCoapSession(host, port, cert_path=cert, key_path=key)
|
||||||
sess.connect()
|
sess.connect()
|
||||||
sess.start_reader()
|
sess.start_reader()
|
||||||
sess.subscribe([...], on_notification=cb) # OBSERVE
|
sess.subscribe([...], on_notification=cb) # OBSERVE
|
||||||
code, body = sess.get(['device', '0']) # Block2 fetch
|
code, body = sess.get(['device', '0']) # Block2 fetch
|
||||||
code, _ = sess.post(['mode','vs','0'], cbor)
|
code, _ = sess.post(['mode','vs','0'], cbor)
|
||||||
sess.close()
|
sess.close()
|
||||||
|
|
||||||
|
Cert material comes from either a file pair (cert_path, key_path) or
|
||||||
|
an in-memory PEM pair (cert_pem, key_pem) — exactly one pair required.
|
||||||
|
The in-memory path exists for callers (e.g. an HA config flow) that
|
||||||
|
mint a client cert at runtime and never write it to disk.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
HANDSHAKE_TIMEOUT_S = 12.0
|
HANDSHAKE_TIMEOUT_S = 12.0
|
||||||
READER_RECV_TIMEOUT_S = 1.0 # short so stop_event propagates quickly
|
READER_RECV_TIMEOUT_S = 1.0 # short so stop_event propagates quickly
|
||||||
MAX_BLOCKS = 32 # safety bound for Block2 fetches
|
MAX_BLOCKS = 32 # safety bound for Block2 fetches
|
||||||
|
|
||||||
def __init__(self, host, port, cert_path, key_path,
|
def __init__(self, host, port, cert_path=None, key_path=None, *,
|
||||||
|
cert_pem=None, key_pem=None,
|
||||||
on_notification=None, mtu=1200,
|
on_notification=None, mtu=1200,
|
||||||
rate_limit_rps: float = _DEFAULT_RATE_LIMIT_RPS):
|
rate_limit_rps: float = _DEFAULT_RATE_LIMIT_RPS):
|
||||||
|
if (cert_path is not None or key_path is not None) and \
|
||||||
|
(cert_pem is not None or key_pem is not None):
|
||||||
|
raise ValueError(
|
||||||
|
"pass either cert_path/key_path or cert_pem/key_pem, not both")
|
||||||
|
if cert_pem is not None or key_pem is not None:
|
||||||
|
if cert_pem is None or key_pem is None:
|
||||||
|
raise ValueError("cert_pem and key_pem must be passed together")
|
||||||
|
elif cert_path is None or key_path is None:
|
||||||
|
raise ValueError(
|
||||||
|
"must pass either cert_path/key_path or cert_pem/key_pem")
|
||||||
|
|
||||||
self.host = host
|
self.host = host
|
||||||
self.port = port
|
self.port = port
|
||||||
self.cert_path = str(cert_path)
|
self.cert_path = str(cert_path) if cert_path is not None else None
|
||||||
self.key_path = str(key_path)
|
self.key_path = str(key_path) if key_path is not None else None
|
||||||
|
self.cert_pem = cert_pem
|
||||||
|
self.key_pem = key_pem
|
||||||
self.on_notification = on_notification # fn(href, payload_bytes)
|
self.on_notification = on_notification # fn(href, payload_bytes)
|
||||||
self.mtu = mtu
|
self.mtu = mtu
|
||||||
self._min_req_interval = 1.0 / rate_limit_rps
|
self._min_req_interval = 1.0 / rate_limit_rps
|
||||||
@@ -136,9 +181,12 @@ class DtlsCoapSession:
|
|||||||
# the OpenSSL instance cryptography bundles — ctypes and cffi bindings
|
# the OpenSSL instance cryptography bundles — ctypes and cffi bindings
|
||||||
# do not expose SSL_CTX_set_security_level on this build.
|
# do not expose SSL_CTX_set_security_level on this build.
|
||||||
ctx.set_cipher_list(b'ECDHE-ECDSA-AES128-GCM-SHA256:@SECLEVEL=0')
|
ctx.set_cipher_list(b'ECDHE-ECDSA-AES128-GCM-SHA256:@SECLEVEL=0')
|
||||||
ctx.use_certificate_chain_file(self.cert_path)
|
if self.cert_pem is not None:
|
||||||
ctx.use_privatekey_file(self.key_path)
|
_load_pem_chain(ctx, self.cert_pem, self.key_pem)
|
||||||
ctx.check_privatekey()
|
else:
|
||||||
|
ctx.use_certificate_chain_file(self.cert_path)
|
||||||
|
ctx.use_privatekey_file(self.key_path)
|
||||||
|
ctx.check_privatekey()
|
||||||
|
|
||||||
conn = SSL.Connection(ctx, None)
|
conn = SSL.Connection(ctx, None)
|
||||||
conn.set_connect_state()
|
conn.set_connect_state()
|
||||||
|
|||||||
@@ -0,0 +1,58 @@
|
|||||||
|
import pytest
|
||||||
|
from OpenSSL import SSL, crypto
|
||||||
|
|
||||||
|
from smartthings_local.protocol.dtls_session import DtlsCoapSession, _load_pem_chain
|
||||||
|
|
||||||
|
|
||||||
|
def _make_self_signed_pem_pair():
|
||||||
|
"""A throwaway self-signed cert + key, just to exercise PEM loading —
|
||||||
|
not meant to resemble a real Samsung client cert."""
|
||||||
|
key = crypto.PKey()
|
||||||
|
key.generate_key(crypto.TYPE_RSA, 2048)
|
||||||
|
|
||||||
|
cert = crypto.X509()
|
||||||
|
cert.get_subject().CN = "test"
|
||||||
|
cert.set_serial_number(1)
|
||||||
|
cert.gmtime_adj_notBefore(0)
|
||||||
|
cert.gmtime_adj_notAfter(3600)
|
||||||
|
cert.set_issuer(cert.get_subject())
|
||||||
|
cert.set_pubkey(key)
|
||||||
|
cert.sign(key, "sha256")
|
||||||
|
|
||||||
|
cert_pem = crypto.dump_certificate(crypto.FILETYPE_PEM, cert).decode()
|
||||||
|
key_pem = crypto.dump_privatekey(crypto.FILETYPE_PEM, key).decode()
|
||||||
|
return cert_pem, key_pem
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_pem_chain_loads_cert_and_key_in_memory():
|
||||||
|
cert_pem, key_pem = _make_self_signed_pem_pair()
|
||||||
|
ctx = SSL.Context(SSL.DTLS_METHOD)
|
||||||
|
_load_pem_chain(ctx, cert_pem, key_pem)
|
||||||
|
ctx.check_privatekey() # raises if cert/key don't match
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_pem_chain_rejects_cert_pem_with_no_certificates():
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
_load_pem_chain(SSL.Context(SSL.DTLS_METHOD), "not a cert", "not a key")
|
||||||
|
|
||||||
|
|
||||||
|
def test_session_requires_exactly_one_cert_source():
|
||||||
|
cert_pem, key_pem = _make_self_signed_pem_pair()
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
DtlsCoapSession("host", 1234) # neither pair given
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
DtlsCoapSession("host", 1234, cert_path="/a", key_path="/b",
|
||||||
|
cert_pem=cert_pem, key_pem=key_pem) # both given
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
DtlsCoapSession("host", 1234, cert_pem=cert_pem) # key_pem missing
|
||||||
|
|
||||||
|
|
||||||
|
def test_session_accepts_pem_pair():
|
||||||
|
cert_pem, key_pem = _make_self_signed_pem_pair()
|
||||||
|
sess = DtlsCoapSession("host", 1234, cert_pem=cert_pem, key_pem=key_pem)
|
||||||
|
assert sess.cert_path is None
|
||||||
|
assert sess.key_path is None
|
||||||
|
assert sess.cert_pem == cert_pem
|
||||||
Reference in new issue
Block a user