Skip to content
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

Add public property google.auth.credentials.Signing.signer #110

Merged
merged 1 commit into from
Feb 16, 2017
Merged
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
8 changes: 7 additions & 1 deletion google/auth/app_engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ def __init__(self, scopes=None, service_account_id=None):
super(Credentials, self).__init__()
self._scopes = scopes
self._service_account_id = service_account_id
self._signer = Signer()

@_helpers.copy_docstring(credentials.Credentials)
def refresh(self, request):
Expand Down Expand Up @@ -156,9 +157,14 @@ def with_scopes(self, scopes):

@_helpers.copy_docstring(credentials.Signing)
def sign_bytes(self, message):
return Signer().sign(message)
return self._signer.sign(message)

@property
@_helpers.copy_docstring(credentials.Signing)
def signer_email(self):
return self.service_account_email

@property
@_helpers.copy_docstring(credentials.Signing)
def signer(self):
return self._signer
7 changes: 7 additions & 0 deletions google/auth/credentials.py
Original file line number Diff line number Diff line change
Expand Up @@ -236,3 +236,10 @@ def signer_email(self):
# pylint: disable=missing-raises-doc
# (pylint doesn't recognize that this is abstract)
raise NotImplementedError('Signer email must be implemented.')

@abc.abstractproperty
def signer(self):
"""google.auth.crypt.Signer: The signer used to sign bytes."""
# pylint: disable=missing-raises-doc
# (pylint doesn't recognize that this is abstract)
raise NotImplementedError('Signer must be implemented.')
5 changes: 5 additions & 0 deletions google/auth/jwt.py
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,11 @@ def sign_bytes(self, message):
def signer_email(self):
return self._issuer

@property
@_helpers.copy_docstring(credentials.Signing)
def signer(self):
return self._signer

def before_request(self, request, method, url, headers):
"""Performs credential-specific before request logic.

Expand Down
5 changes: 5 additions & 0 deletions google/oauth2/service_account.py
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,11 @@ def refresh(self, request):
def sign_bytes(self, message):
return self._signer.sign(message)

@property
@_helpers.copy_docstring(credentials.Signing)
def signer(self):
return self._signer

@property
@_helpers.copy_docstring(credentials.Signing)
def signer_email(self):
Expand Down
3 changes: 3 additions & 0 deletions tests/oauth2/test_service_account.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ def test_sign_bytes(self):
signature = self.credentials.sign_bytes(to_sign)
assert crypt.verify_signature(to_sign, signature, PUBLIC_CERT_BYTES)

def test_signer(self):
assert isinstance(self.credentials.signer, crypt.Signer)

def test_signer_email(self):
assert self.credentials.signer_email == self.SERVICE_ACCOUNT_EMAIL

Expand Down
4 changes: 4 additions & 0 deletions tests/test_app_engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@ def test_sign_bytes(self, app_identity_mock):
assert signature == mock.sentinel.signature
app_identity_mock.sign_blob.assert_called_with(to_sign)

def test_signer(self, app_identity_mock):
credentials = app_engine.Credentials()
assert isinstance(credentials.signer, app_engine.Signer)

def test_signer_email(self, app_identity_mock):
credentials = app_engine.Credentials()
assert credentials.signer_email == credentials.service_account_email
3 changes: 3 additions & 0 deletions tests/test_jwt.py
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,9 @@ def test_sign_bytes(self):
signature = self.credentials.sign_bytes(to_sign)
assert crypt.verify_signature(to_sign, signature, PUBLIC_CERT_BYTES)

def test_signer(self):
assert isinstance(self.credentials.signer, crypt.Signer)

def test_signer_email(self):
assert (self.credentials.signer_email ==
SERVICE_ACCOUNT_INFO['client_email'])
Expand Down