Skip to content

Add jwt.OnDemandCredentials #142

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

Jump to bottom
Merged
theacodes merged 2 commits into from
Mar 28, 2017
Merged

Add jwt.OnDemandCredentials #142

theacodes merged 2 commits into from
Mar 28, 2017

Conversation

@theacodes
Copy link
Contributor

@theacodes theacodes commented Mar 23, 2017

Resolves #136.

Note: this adds a new dependency on cachetools.

@theacodes
Copy link
Contributor Author

theacodes commented Mar 23, 2017

/cc @jboeuf

@jboeuf
Copy link

jboeuf commented Mar 23, 2017

waow. Awesome. thanks much for the quick turnaround!

@theacodes
Copy link
Contributor Author

theacodes commented Mar 23, 2017

waow. Awesome. thanks much for the quick turnaround!

We had most of this code already, we just needed justification for it.

@jboeuf
Copy link

jboeuf commented Mar 23, 2017 via email

@theacodes
Copy link
Contributor Author

theacodes commented Mar 24, 2017

@dhermes @lukesneeringer re-based and should be ready for review. :)

dhermes
dhermes reviewed Mar 28, 2017
View reviewed changes
Copy link
Contributor

@dhermes dhermes left a comment

Choose a reason for hiding this comment

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

What should I know about cachetools (never having used it)? Worth making it an optional dependency?

google/auth/jwt.py Outdated


_DEFAULT_TOKEN_LIFETIME_SECS = 3600 # 1 hour in seconds
_DEFAULT_TOKEN_LIFETIME_SECS = 3600 # 1 hour in sections

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

google/auth/jwt.py
Args:
signer (google.auth.crypt.Signer): The signer used to sign JWTs.
issuer (str): The `iss` claim.
subject (str): The `sub` claim.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

google/auth/jwt.py
signer (google.auth.crypt.Signer): The signer used to sign JWTs.
issuer (str): The `iss` claim.
subject (str): The `sub` claim.
additional_claims (Mapping[str, str]): Any additional claims for

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

google/auth/jwt.py
max_cache_size (int): The maximum number of JWT tokens to keep in
cache. Tokens are cached using :class:`cachetools.LRUCache`.
"""
super(OnDemandCredentials, self).__init__()

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

google/auth/jwt.py Outdated
if additional_claims is not None:
self._additional_claims = additional_claims
else:
self._additional_claims = {}

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

google/auth/jwt.py Outdated
def valid(self):
"""Checks the validity of the credentials.
These credentials are always valid.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

google/auth/jwt.py Outdated
Returns:
bytes: The encoded JWT.
"""

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

google/auth/jwt.py
google.auth.RefreshError
"""
# pylint: disable=unused-argument
# (pylint doesn't correctly recognize overridden methods.)

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

tests/test_jwt.py Outdated
assert self.credentials.valid


class TestOnDemandCredentials:

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

tests/test_jwt.py
SERVICE_ACCOUNT_EMAIL = '[email protected]'
SUBJECT = 'subject'
ADDITIONAL_CLAIMS = {'meta': 'data'}
credentials = None

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

@theacodes
Copy link
Contributor Author

theacodes commented Mar 28, 2017

What should I know about cachetools (never having used it)? Worth making it an optional dependency?

It's a very well tested, maintained, and focused library that provides a pretty damn good implementation of an LRU cache. We could alternatively just pull in the LRUCache class (and associated tests) into this library.

@dhermes
Copy link
Contributor

dhermes commented Mar 28, 2017

Your call

@theacodes
Copy link
Contributor Author

theacodes commented Mar 28, 2017

I'm okay with the dependency. @lukesneeringer WDYT?

@lukesneeringer
Copy link

lukesneeringer commented Mar 28, 2017

Just did some quick research. I prefer the dep over vendoring.

@theacodes theacodes merged commit cfbfd25 into master Mar 28, 2017
@theacodes theacodes deleted the on-demand-jwt branch March 28, 2017 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lukesneeringer lukesneeringer Awaiting requested review from lukesneeringer

1 more reviewer

@dhermes dhermes dhermes approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@theacodes @jboeuf @dhermes @lukesneeringer