File size: 13,751 Bytes
065fee7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 |
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Tests for the reauth module."""
import base64
import os
import sys
import mock
import pytest # type: ignore
import pyu2f # type: ignore
from google.auth import exceptions
from google.oauth2 import challenges
from google.oauth2.webauthn_types import (
AuthenticationExtensionsClientInputs,
AuthenticatorAssertionResponse,
GetRequest,
GetResponse,
PublicKeyCredentialDescriptor,
)
def test_get_user_password():
with mock.patch("getpass.getpass", return_value="foo"):
assert challenges.get_user_password("") == "foo"
def test_security_key():
metadata = {
"status": "READY",
"challengeId": 2,
"challengeType": "SECURITY_KEY",
"securityKey": {
"applicationId": "security_key_application_id",
"challenges": [
{
"keyHandle": "some_key",
"challenge": base64.urlsafe_b64encode(
"some_challenge".encode("ascii")
).decode("ascii"),
}
],
"relyingPartyId": "security_key_application_id",
},
}
mock_key = mock.Mock()
challenge = challenges.SecurityKeyChallenge()
# Test the case that security key challenge is passed with applicationId and
# relyingPartyId the same.
os.environ.pop('"GOOGLE_AUTH_WEBAUTHN_PLUGIN"', None)
with mock.patch("pyu2f.model.RegisteredKey", return_value=mock_key):
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
mock_authenticate.return_value = "security key response"
assert challenge.name == "SECURITY_KEY"
assert challenge.is_locally_eligible
assert challenge.obtain_challenge_input(metadata) == {
"securityKey": "security key response"
}
mock_authenticate.assert_called_with(
"security_key_application_id",
[{"key": mock_key, "challenge": b"some_challenge"}],
print_callback=sys.stderr.write,
)
# Test the case that webauthn plugin is available
os.environ["GOOGLE_AUTH_WEBAUTHN_PLUGIN"] = "plugin"
with mock.patch(
"google.oauth2.challenges.SecurityKeyChallenge._obtain_challenge_input_webauthn",
return_value={"securityKey": "security key response"},
):
assert challenge.obtain_challenge_input(metadata) == {
"securityKey": "security key response"
}
os.environ.pop('"GOOGLE_AUTH_WEBAUTHN_PLUGIN"', None)
# Test the case that security key challenge is passed with applicationId and
# relyingPartyId different, first call works.
metadata["securityKey"]["relyingPartyId"] = "security_key_relying_party_id"
sys.stderr.write("metadata=" + str(metadata) + "\n")
with mock.patch("pyu2f.model.RegisteredKey", return_value=mock_key):
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
mock_authenticate.return_value = "security key response"
assert challenge.name == "SECURITY_KEY"
assert challenge.is_locally_eligible
assert challenge.obtain_challenge_input(metadata) == {
"securityKey": "security key response"
}
mock_authenticate.assert_called_with(
"security_key_relying_party_id",
[{"key": mock_key, "challenge": b"some_challenge"}],
print_callback=sys.stderr.write,
)
# Test the case that security key challenge is passed with applicationId and
# relyingPartyId different, first call fails, requires retry.
metadata["securityKey"]["relyingPartyId"] = "security_key_relying_party_id"
with mock.patch("pyu2f.model.RegisteredKey", return_value=mock_key):
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
assert challenge.name == "SECURITY_KEY"
assert challenge.is_locally_eligible
mock_authenticate.side_effect = [
pyu2f.errors.U2FError(pyu2f.errors.U2FError.DEVICE_INELIGIBLE),
"security key response",
]
assert challenge.obtain_challenge_input(metadata) == {
"securityKey": "security key response"
}
calls = [
mock.call(
"security_key_relying_party_id",
[{"key": mock_key, "challenge": b"some_challenge"}],
print_callback=sys.stderr.write,
),
mock.call(
"security_key_application_id",
[{"key": mock_key, "challenge": b"some_challenge"}],
print_callback=sys.stderr.write,
),
]
mock_authenticate.assert_has_calls(calls)
# Test various types of exceptions.
with mock.patch("pyu2f.model.RegisteredKey", return_value=mock_key):
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
mock_authenticate.side_effect = pyu2f.errors.U2FError(
pyu2f.errors.U2FError.DEVICE_INELIGIBLE
)
assert challenge.obtain_challenge_input(metadata) is None
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
mock_authenticate.side_effect = pyu2f.errors.U2FError(
pyu2f.errors.U2FError.TIMEOUT
)
assert challenge.obtain_challenge_input(metadata) is None
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
mock_authenticate.side_effect = pyu2f.errors.PluginError()
assert challenge.obtain_challenge_input(metadata) is None
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
mock_authenticate.side_effect = pyu2f.errors.U2FError(
pyu2f.errors.U2FError.BAD_REQUEST
)
with pytest.raises(pyu2f.errors.U2FError):
challenge.obtain_challenge_input(metadata)
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
mock_authenticate.side_effect = pyu2f.errors.NoDeviceFoundError()
assert challenge.obtain_challenge_input(metadata) is None
with mock.patch(
"pyu2f.convenience.authenticator.CompositeAuthenticator.Authenticate"
) as mock_authenticate:
mock_authenticate.side_effect = pyu2f.errors.UnsupportedVersionException()
with pytest.raises(pyu2f.errors.UnsupportedVersionException):
challenge.obtain_challenge_input(metadata)
with mock.patch.dict("sys.modules"):
sys.modules["pyu2f"] = None
with pytest.raises(exceptions.ReauthFailError) as excinfo:
challenge.obtain_challenge_input(metadata)
assert excinfo.match(r"pyu2f dependency is required")
def test_security_key_webauthn():
metadata = {
"status": "READY",
"challengeId": 2,
"challengeType": "SECURITY_KEY",
"securityKey": {
"applicationId": "security_key_application_id",
"challenges": [
{
"keyHandle": "some_key",
"challenge": base64.urlsafe_b64encode(
"some_challenge".encode("ascii")
).decode("ascii"),
}
],
"relyingPartyId": "security_key_application_id",
},
}
challenge = challenges.SecurityKeyChallenge()
sk = metadata["securityKey"]
sk_challenges = sk["challenges"]
application_id = sk["applicationId"]
allow_credentials = []
for sk_challenge in sk_challenges:
allow_credentials.append(
PublicKeyCredentialDescriptor(id=sk_challenge["keyHandle"])
)
extension = AuthenticationExtensionsClientInputs(appid=application_id)
get_request = GetRequest(
origin=challenges.REAUTH_ORIGIN,
rpid=application_id,
challenge=challenge._unpadded_urlsafe_b64recode(sk_challenge["challenge"]),
timeout_ms=challenges.WEBAUTHN_TIMEOUT_MS,
allow_credentials=allow_credentials,
user_verification="required",
extensions=extension,
)
assertion_resp = AuthenticatorAssertionResponse(
client_data_json="clientDataJSON",
authenticator_data="authenticatorData",
signature="signature",
user_handle="userHandle",
)
get_response = GetResponse(
id="id",
response=assertion_resp,
authenticator_attachment="authenticatorAttachment",
client_extension_results="clientExtensionResults",
)
response = {
"clientData": get_response.response.client_data_json,
"authenticatorData": get_response.response.authenticator_data,
"signatureData": get_response.response.signature,
"applicationId": "security_key_application_id",
"keyHandle": get_response.id,
"securityKeyReplyType": 2,
}
mock_handler = mock.Mock()
mock_handler.get.return_value = get_response
# Test success case
assert challenge._obtain_challenge_input_webauthn(metadata, mock_handler) == {
"securityKey": response
}
mock_handler.get.assert_called_with(get_request)
# Test exceptions
# Missing Values
sk = metadata["securityKey"]
metadata["securityKey"] = None
with pytest.raises(exceptions.InvalidValue):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
metadata["securityKey"] = sk
c = metadata["securityKey"]["challenges"]
metadata["securityKey"]["challenges"] = None
with pytest.raises(exceptions.InvalidValue):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
metadata["securityKey"]["challenges"] = []
with pytest.raises(exceptions.InvalidValue):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
metadata["securityKey"]["challenges"] = c
aid = metadata["securityKey"]["applicationId"]
metadata["securityKey"]["applicationId"] = None
with pytest.raises(exceptions.InvalidValue):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
metadata["securityKey"]["applicationId"] = aid
rpi = metadata["securityKey"]["relyingPartyId"]
metadata["securityKey"]["relyingPartyId"] = None
with pytest.raises(exceptions.InvalidValue):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
metadata["securityKey"]["relyingPartyId"] = rpi
kh = metadata["securityKey"]["challenges"][0]["keyHandle"]
metadata["securityKey"]["challenges"][0]["keyHandle"] = None
with pytest.raises(exceptions.InvalidValue):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
metadata["securityKey"]["challenges"][0]["keyHandle"] = kh
ch = metadata["securityKey"]["challenges"][0]["challenge"]
metadata["securityKey"]["challenges"][0]["challenge"] = None
with pytest.raises(exceptions.InvalidValue):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
metadata["securityKey"]["challenges"][0]["challenge"] = ch
# Handler Exceptions
mock_handler.get.side_effect = exceptions.MalformedError
with pytest.raises(exceptions.MalformedError):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
mock_handler.get.side_effect = exceptions.InvalidResource
with pytest.raises(exceptions.InvalidResource):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
mock_handler.get.side_effect = exceptions.ReauthFailError
with pytest.raises(exceptions.ReauthFailError):
challenge._obtain_challenge_input_webauthn(metadata, mock_handler)
@mock.patch("getpass.getpass", return_value="foo")
def test_password_challenge(getpass_mock):
challenge = challenges.PasswordChallenge()
with mock.patch("getpass.getpass", return_value="foo"):
assert challenge.is_locally_eligible
assert challenge.name == "PASSWORD"
assert challenges.PasswordChallenge().obtain_challenge_input({}) == {
"credential": "foo"
}
with mock.patch("getpass.getpass", return_value=None):
assert challenges.PasswordChallenge().obtain_challenge_input({}) == {
"credential": " "
}
def test_saml_challenge():
challenge = challenges.SamlChallenge()
assert challenge.is_locally_eligible
assert challenge.name == "SAML"
with pytest.raises(exceptions.ReauthSamlChallengeFailError):
challenge.obtain_challenge_input(None)
|