Skip to content

Add headers parameter to generate() #8

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Dec 23, 2020
Merged

Add headers parameter to generate() #8

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6b53c8f
Add headers parameter to generate()
jay0lee Dec 22, 2020
7b3019d
jose_header not jose_headers
jay0lee Dec 22, 2020
572a679
first attempt at resolving pylint warnings
jay0lee Dec 23, 2020
859b456
pylint warning fix take two
jay0lee Dec 23, 2020
2f41417
reformat like black wants it.
jay0lee Dec 23, 2020
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
23 changes: 14 additions & 9 deletions adafruit_jwt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ def validate(jwt):
# Attempt to decode JOSE header
try:
jose_header = STRING_TOOLS.urlsafe_b64decode(jwt.split(".")[0])
except UnicodeError:
raise UnicodeError("Unable to decode JOSE header.")
except UnicodeError as unicode_error:
raise UnicodeError("Unable to decode JOSE header.") from unicode_error
# Check for typ and alg in decoded JOSE header
if "typ" not in jose_header:
raise TypeError("JOSE Header does not contain required type key.")
Expand All @@ -87,17 +87,19 @@ def validate(jwt):
# Attempt to decode claim set
try:
claims = json.loads(STRING_TOOLS.urlsafe_b64decode(jwt.split(".")[1]))
except UnicodeError:
raise UnicodeError("Invalid claims encoding.")
except UnicodeError as unicode_error:
raise UnicodeError("Invalid claims encoding.") from unicode_error
if not hasattr(claims, "keys"):
raise TypeError("Provided claims is not a JSON dict. object")
return (jose_header, claims)

@staticmethod
def generate(claims, private_key_data=None, algo=None):
def generate(claims, private_key_data=None, algo=None, headers=None):
"""Generates and returns a new JSON Web Token.
:param dict claims: JWT claims set
:param str private_key_data: Decoded RSA private key data.
:param str algo: algorithm to be used. One of None, RS256, RS384 or RS512.
:param dict headers: additional headers for the claim.
:rtype: str
"""
# Allow for unencrypted JWTs
Expand All @@ -108,6 +110,8 @@ def generate(claims, private_key_data=None, algo=None):
# Create the JOSE Header
# https://tools.ietf.org/html/rfc7519#section-5
jose_header = {"typ": "JWT", "alg": algo}
if headers:
jose_header.update(headers)
payload = "{}.{}".format(
STRING_TOOLS.urlsafe_b64encode(json.dumps(jose_header).encode("utf-8")),
STRING_TOOLS.urlsafe_b64encode(json.dumps(claims).encode("utf-8")),
Expand Down Expand Up @@ -139,8 +143,7 @@ def generate(claims, private_key_data=None, algo=None):

# pylint: disable=invalid-name
class STRING_TOOLS:
"""Tools and helpers for URL-safe string encoding.
"""
"""Tools and helpers for URL-safe string encoding."""

# Some strings for ctype-style character classification
whitespace = " \t\n\r\v\f"
Expand Down Expand Up @@ -179,8 +182,10 @@ def _bytes_from_decode_data(str_data):
if isinstance(str_data, str):
try:
return str_data.encode("ascii")
except:
raise ValueError("string argument should contain only ASCII characters")
except BaseException as error:
raise ValueError(
"string argument should contain only ASCII characters"
) from error
elif isinstance(str_data, bit_types):
return str_data
else:
Expand Down