Skip to content

Thumbprint for certificate made optional #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions msal/application.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,25 +66,27 @@ def _str2bytes(raw):
except:
return raw

def _extract_cert_and_thumbprints(private_key, cert):
# Cert concepts https://security.stackexchange.com/a/226758/125264
from cryptography.hazmat.primitives import hashes, serialization
cert_pem = cert.public_bytes(encoding=serialization.Encoding.PEM).decode()
x5c = [
'\n'.join(cert_pem.splitlines()[1:-1])
]
sha256_thumbprint = cert.fingerprint(hashes.SHA256()).hex()
sha1_thumbprint = cert.fingerprint(hashes.SHA1()).hex()
return private_key, sha256_thumbprint, sha1_thumbprint, x5c

def _parse_pfx(pfx_path, passphrase_bytes):
# Cert concepts https://security.stackexchange.com/a/226758/125264
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.serialization import pkcs12
with open(pfx_path, 'rb') as f:
private_key, cert, _ = pkcs12.load_key_and_certificates( # cryptography 2.5+
# https://cryptography.io/en/latest/hazmat/primitives/asymmetric/serialization/#cryptography.hazmat.primitives.serialization.pkcs12.load_key_and_certificates
f.read(), passphrase_bytes)
if not (private_key and cert):
raise ValueError("Your PFX file shall contain both private key and cert")
cert_pem = cert.public_bytes(encoding=serialization.Encoding.PEM).decode() # cryptography 1.0+
x5c = [
'\n'.join(cert_pem.splitlines()[1:-1]) # Strip the "--- header ---" and "--- footer ---"
]
sha256_thumbprint = cert.fingerprint(hashes.SHA256()).hex() # cryptography 0.7+
sha1_thumbprint = cert.fingerprint(hashes.SHA1()).hex() # cryptography 0.7+
# https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object
return private_key, sha256_thumbprint, sha1_thumbprint, x5c
return _extract_cert_and_thumbprints(private_key, cert)


def _load_private_key_from_pem_str(private_key_pem_str, passphrase_bytes):
Expand Down Expand Up @@ -306,7 +308,7 @@ def __init__(

{
"private_key": "...-----BEGIN PRIVATE KEY-----... in PEM format",
"thumbprint": "A1B2C3D4E5F6...",
"thumbprint": "A1B2C3D4E5F6...", (Deprecated. Provide the public certificate instead. Added in version 1.34.0)
"public_certificate": "...-----BEGIN CERTIFICATE-----...",
"passphrase": "Passphrase if the private_key is encrypted (Optional. Added in version 1.6.0)",
}
Expand Down Expand Up @@ -815,6 +817,22 @@ def _build_client(self, client_credential, authority, skip_regional_client=False
passphrase_bytes)
if client_credential.get("public_certificate") is True and x5c:
headers["x5c"] = x5c
elif (client_credential.get("private_key")
and client_credential.get("public_certificate")
and not client_credential.get("thumbprint")): #in case user does not pass thumbprint but only certificate and private key
if passphrase_bytes: # PEM with passphrase
private_key = _load_private_key_from_pem_str(
client_credential['private_key'], passphrase_bytes)
else: # PEM without passphrase
private_key = client_credential['private_key']

private_key, sha256_thumbprint, sha1_thumbprint, x5c =(
_extract_cert_and_thumbprints(
private_key,
client_credential['public_certificate']))
if x5c:
headers["x5c"] = x5c

elif (
client_credential.get("private_key") # PEM blob
and client_credential.get("thumbprint")):
Expand Down
2 changes: 1 addition & 1 deletion msal/sku.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"""

# The __init__.py will import this. Not the other way around.
__version__ = "1.33.0b1"
__version__ = "1.34.0b1"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also revert this change.

We will only bump version number when we cut a release, and decide the actual number at that time.

Besides, bumping version number in each feature PR brings complications in case we would end up reverting the feature PR.

SKU = "MSAL.Python"