def test06_client_id_service_description(self):
auth = IIIFAuth()
auth.client_id_uri = 'id3'
auth.profile_base = 'http://pb3/'
lsd = auth.client_id_service_description()
self.assertEqual( lsd['@id'], 'id3' )
self.assertEqual( lsd['profile'], 'http://pb3/clientId' )
def test07_access_token_service_description(self):
auth = IIIFAuth()
auth.access_token_uri = 'id4'
auth.profile_base = 'http://pb4/'
lsd = auth.access_token_service_description()
self.assertEqual( lsd['@id'], 'id4' )
self.assertEqual( lsd['profile'], 'http://pb4/token' )
def test05_logout_service_description(self):
auth = IIIFAuth()
auth.logout_uri = 'id2'
auth.profile_base = 'http://pb2/'
lsd = auth.logout_service_description()
self.assertEqual( lsd['@id'], 'id2' )
self.assertEqual( lsd['profile'], 'http://pb2/logout' )
def test02_set_cookie_prefix(self):
auth = IIIFAuth()
self.assertTrue( re.match(r'\d{6}_$',auth.cookie_prefix) )
auth.set_cookie_prefix()
self.assertTrue( re.match(r'\d{6}_$',auth.cookie_prefix) )
auth.set_cookie_prefix('ghi')
self.assertEqual( auth.cookie_prefix, 'ghi' )
def test01_empty_auth_defined(self):
"""Test empty auth."""
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.add_services(info)
self.assertJSONEqual(info.as_json(
validate=False), '{\n "@context": "http://iiif.io/api/image/2/context.json", \n "@id": "http://example.com/i1", \n "profile": [\n "http://iiif.io/api/image/2/level1.json"\n ], \n "protocol": "http://iiif.io/api/image"\n}')
self.assertEqual(info.service, None)
def test01_empty_auth_defined(self):
"""Test empty auth."""
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.add_services(info)
self.assertJSONEqual(info.as_json(
validate=False), '{\n "@context": "http://iiif.io/api/image/2/context.json", \n "@id": "http://example.com/i1", \n "profile": [\n "http://iiif.io/api/image/2/level1.json"\n ], \n "protocol": "http://iiif.io/api/image"\n}')
self.assertEqual(info.service, None)
def test02_just_login(self):
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.login_uri = 'http://example.com/login'
auth.add_services(info)
self.assertEqual( info.service['@id'], "http://example.com/login" )
self.assertEqual( info.service['label'], "Login to image server" )
self.assertEqual( info.service['profile'], "http://iiif.io/api/auth/0/login" )
def test05_logout_service_description(self):
"""Test logout_service_description."""
auth = IIIFAuth()
auth.logout_uri = 'id2'
auth.profile_base = 'http://pb2/'
lsd = auth.logout_service_description()
self.assertEqual(lsd['@id'], 'id2')
self.assertEqual(lsd['profile'], 'http://pb2/logout')
def test02_set_cookie_prefix(self):
"""Test set_cookie_prefix."""
auth = IIIFAuth()
self.assertRegexpMatches(auth.cookie_prefix, r'\d{6}_$')
auth.set_cookie_prefix()
self.assertRegexpMatches(auth.cookie_prefix, r'\d{6}_$')
auth.set_cookie_prefix('ghi')
self.assertEqual(auth.cookie_prefix, 'ghi')
def test06_client_id_service_description(self):
"""Test client_id_service_description."""
auth = IIIFAuth()
auth.client_id_uri = 'id3'
auth.profile_base = 'http://pb3/'
lsd = auth.client_id_service_description()
self.assertEqual(lsd['@id'], 'id3')
self.assertEqual(lsd['profile'], 'http://pb3/clientId')
def test07_access_token_service_description(self):
"""Test access_token_service_description."""
auth = IIIFAuth()
auth.access_token_uri = 'id4'
auth.profile_base = 'http://pb4/'
lsd = auth.access_token_service_description()
self.assertEqual(lsd['@id'], 'id4')
self.assertEqual(lsd['profile'], 'http://pb4/token')
def test01_init(self):
"""Test initialization with params and cookie prefix."""
auth = IIIFAuth()
self.assertEqual(auth.profile_base, 'http://iiif.io/api/auth/1/')
self.assertEqual(auth.name, "image server")
auth = IIIFAuth(cookie_prefix='abc_')
self.assertEqual(auth.cookie_prefix, 'abc_')
self.assertEqual(auth.access_cookie_name, 'abc_access')
def test12_null_authn_authz(self):
"""Test null authn and auth.
No auth so they return False always.
"""
self.assertEqual(IIIFAuth().info_authn(), False)
self.assertEqual(IIIFAuth().info_authz(), False)
self.assertEqual(IIIFAuth().image_authn(), False)
self.assertEqual(IIIFAuth().image_authz(), False)
def test04_login_service_description(self):
auth = IIIFAuth()
lsd = auth.login_service_description()
self.assertEqual( lsd['profile'], 'http://iiif.io/api/auth/0/login' )
auth.login_uri = 'id1'
auth.profile_base = 'http://pb1/'
lsd = auth.login_service_description()
self.assertEqual( lsd['@id'], 'id1' )
self.assertEqual( lsd['profile'], 'http://pb1/login' )
def test15_access_token(self):
"""Test access_token()."""
auth = IIIFAuth()
# Success
token = auth.access_token('cookie1')
self.assertTrue(token)
self.assertIn(token, auth.access_tokens)
self.assertEqual(len(auth.access_tokens), 1)
# Failure
self.assertFalse(auth.access_token(None))
def test15_access_token(self):
"""Test access_token()."""
auth = IIIFAuth()
# Success
token = auth.access_token('cookie1')
self.assertTrue(token)
self.assertIn(token, auth.access_tokens)
self.assertEqual(len(auth.access_tokens), 1)
# Failure
self.assertFalse(auth.access_token(None))
def test02_just_login(self):
"""Test just login."""
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.login_uri = 'http://example.com/login'
auth.add_services(info)
self.assertEqual(info.service['@id'], "http://example.com/login")
self.assertEqual(info.service['label'], "Login to image server")
self.assertEqual(info.service['profile'],
"http://iiif.io/api/auth/1/login")
def test13_access_cookie(self):
"""Test access_cookie()."""
auth = IIIFAuth()
auth.account_allowed = mock.Mock(return_value=True)
cookie = auth.access_cookie('abc')
self.assertTrue(cookie)
self.assertIn(cookie, auth.access_cookies)
auth.account_allowed = mock.Mock(return_value=False)
cookie = auth.access_cookie('abc')
self.assertEqual(cookie, None)
self.assertEqual(len(auth.access_cookies), 1)
def test11_access_token_response(self):
"""Test structure of access token response."""
# no token
err_response = IIIFAuth().access_token_response(None)
self.assertEqual(err_response['error'], 'client_unauthorized')
self.assertNotIn('access_token', err_response)
# token
good_response = IIIFAuth().access_token_response('TOKEN_HERE')
self.assertEqual(good_response['accessToken'], 'TOKEN_HERE')
self.assertTrue(int(good_response['expiresIn']) > 10)
self.assertNotIn('error', good_response)
def test04_login_and_client_id(self):
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.login_uri = 'http://example.com/login'
auth.client_id_uri = 'http://example.com/client_id'
auth.add_services(info)
self.assertEqual( info.service['@id'], "http://example.com/login" )
self.assertEqual( info.service['label'], "Login to image server" )
self.assertEqual( info.service['profile'], "http://iiif.io/api/auth/0/login" )
svcs = info.service['service']
self.assertEqual( svcs['@id'], "http://example.com/client_id" )
self.assertEqual( svcs['profile'], "http://iiif.io/api/auth/0/clientId" )
def test05_login_and_access_token(self):
"""Test login and access token."""
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.login_uri = 'http://example.com/login'
auth.access_token_uri = 'http://example.com/token'
auth.add_services(info)
self.assertEqual(info.service['@id'], "http://example.com/login")
self.assertEqual(info.service['label'], "Login to image server")
self.assertEqual(info.service['profile'],
"http://iiif.io/api/auth/1/login")
svcs = info.service['service']
self.assertEqual(svcs['@id'], "http://example.com/token")
self.assertEqual(svcs['profile'], "http://iiif.io/api/auth/1/token")
def test06_full_set(self):
"""Test full set of auth services."""
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.name = "Whizzo!"
auth.logout_uri = 'http://example.com/logout'
auth.access_token_uri = 'http://example.com/token'
auth.client_id_uri = 'http://example.com/clientId'
auth.login_uri = 'http://example.com/login'
auth.add_services(info)
self.assertEqual(info.service['@id'], "http://example.com/login")
self.assertEqual(info.service['label'], "Login to Whizzo!")
svcs = info.service['service']
self.assertEqual(svcs[0]['@id'], "http://example.com/logout")
self.assertEqual(svcs[1]['@id'], "http://example.com/clientId")
self.assertEqual(svcs[2]['@id'], "http://example.com/token")
def test09_host_port_prefix(self):
auth = IIIFAuth()
self.assertEqual( auth.scheme_host_port_prefix('sc','x', '9', 'z'), 'sc://x:9/z' )
self.assertEqual( auth.scheme_host_port_prefix(host='x', prefix='z'), 'http://x/z' )
self.assertEqual( auth.scheme_host_port_prefix(host='yy'), 'http://yy' )
self.assertEqual( auth.scheme_host_port_prefix(host='yy',port=80), 'http://yy' )
self.assertEqual( auth.scheme_host_port_prefix(host='yy',port=81,prefix='x'), 'http://yy:81/x' )
self.assertEqual( auth.scheme_host_port_prefix(scheme='https',host='z1',port=443), 'https://z1' )
self.assertEqual( auth.scheme_host_port_prefix(scheme='https',host='z2',port=444), 'https://z2:444' )
def test14_access_cooked_valid(self):
"""Test access_cooked_valid()."""
auth = IIIFAuth()
now = int(time.time())
# No allowed cookies stored, so reject
self.assertFalse(auth.access_cookie_valid('a-cookie', 'testy'))
# Wrong cookie, so reject
auth.access_cookies['cookie1'] = now
self.assertFalse(auth.access_cookie_valid('cookie2', 'testy'))
# Right cookie, recent, so accept
self.assertTrue(auth.access_cookie_valid('cookie1', 'testy'))
# Make cookie old, so reject
auth.access_cookies['cookie1'] = now - auth.access_cookie_lifetime - 2
self.assertFalse(auth.access_cookie_valid('cookie1', 'testy'))
self.assertEqual(len(auth.access_cookies), 1)
# Make cookie very old, so deleted
auth.access_cookies[
'cookie1'] = now - 2 * auth.access_cookie_lifetime - 2
self.assertFalse(auth.access_cookie_valid('cookie1', 'testy'))
self.assertEqual(len(auth.access_cookies), 0)
def test16_access_token_valid(self):
"""Test access_token_valid()."""
auth = IIIFAuth()
now = int(time.time())
# No allowed tokens stored, so reject
self.assertFalse(auth.access_token_valid('a-token', 'testy'))
# Wrong token, so reject
auth.access_tokens['token1'] = ('cookie1', now)
self.assertFalse(auth.access_token_valid('token2', 'testy'))
# Right token, recent, so accept
self.assertTrue(auth.access_token_valid('token1', 'testy'))
# Make token old, so reject
auth.access_tokens['token1'] = ('cookie1',
now - auth.access_token_lifetime - 2)
self.assertFalse(auth.access_token_valid('token1', 'testy'))
self.assertEqual(len(auth.access_tokens), 1)
# Make token very old, so deleted
auth.access_tokens['token1'] = ('cookie1', now -
2 * auth.access_token_lifetime - 2)
self.assertFalse(auth.access_token_valid('token1', 'testy'))
self.assertEqual(len(auth.access_tokens), 0)
def test04_login_service_description(self):
"""Test login_service_description."""
auth = IIIFAuth()
lsd = auth.login_service_description()
self.assertEqual(lsd['profile'], 'http://iiif.io/api/auth/1/login')
auth.login_uri = 'id1'
auth.profile_base = 'http://pb1/'
lsd = auth.login_service_description()
self.assertEqual(lsd['@id'], 'id1')
self.assertEqual(lsd['profile'], 'http://pb1/login')
# Addition of auth_type in label
auth.auth_type = "my-auth"
lsd = auth.login_service_description()
self.assertIn('(my-auth)', lsd['label'])
def test02_set_cookie_prefix(self):
"""Test set_cookie_prefix."""
auth = IIIFAuth()
self.assertTrue(re.match(r'\d{6}_$', auth.cookie_prefix))
auth.set_cookie_prefix()
self.assertTrue(re.match(r'\d{6}_$', auth.cookie_prefix))
auth.set_cookie_prefix('ghi')
self.assertEqual(auth.cookie_prefix, 'ghi')
def test02_set_cookie_prefix(self):
"""Test set_cookie_prefix."""
auth = IIIFAuth()
self.assertRegexpMatches(auth.cookie_prefix, r'\d{6}_$')
auth.set_cookie_prefix()
self.assertRegexpMatches(auth.cookie_prefix, r'\d{6}_$')
auth.set_cookie_prefix('ghi')
self.assertEqual(auth.cookie_prefix, 'ghi')
def test06_full_set(self):
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.name = "Whizzo!"
auth.logout_uri = 'http://example.com/logout'
auth.access_token_uri = 'http://example.com/token'
auth.client_id_uri = 'http://example.com/clientId'
auth.login_uri = 'http://example.com/login'
auth.add_services(info)
self.assertEqual( info.service['@id'], "http://example.com/login" )
self.assertEqual( info.service['label'], "Login to Whizzo!" )
svcs = info.service['service']
self.assertEqual( svcs[0]['@id'], "http://example.com/logout" )
self.assertEqual( svcs[1]['@id'], "http://example.com/clientId" )
self.assertEqual( svcs[2]['@id'], "http://example.com/token" )
def test16_access_token_valid(self):
"""Test access_token_valid()."""
auth = IIIFAuth()
now = int(time.time())
# No allowed tokens stored, so reject
self.assertFalse(auth.access_token_valid('a-token', 'testy'))
# Wrong token, so reject
auth.access_tokens['token1'] = ('cookie1', now)
self.assertFalse(auth.access_token_valid('token2', 'testy'))
# Right token, recent, so accept
self.assertTrue(auth.access_token_valid('token1', 'testy'))
# Make token old, so reject
auth.access_tokens['token1'] = ('cookie1', now - auth.access_token_lifetime - 2)
self.assertFalse(auth.access_token_valid('token1', 'testy'))
self.assertEqual(len(auth.access_tokens), 1)
# Make token very old, so deleted
auth.access_tokens['token1'] = ('cookie1', now - 2 * auth.access_token_lifetime - 2)
self.assertFalse(auth.access_token_valid('token1', 'testy'))
self.assertEqual(len(auth.access_tokens), 0)
def test08_scheme_host_port_prefix(self):
"""Test URI building with scheme_host_port_prefix."""
auth = IIIFAuth()
self.assertEqual(auth.scheme_host_port_prefix('sc', 'x', '9', 'z'),
'sc://x:9/z')
self.assertEqual(auth.scheme_host_port_prefix(host='x', prefix='z'),
'http://x/z')
self.assertEqual(auth.scheme_host_port_prefix(host='yy'), 'http://yy')
self.assertEqual(auth.scheme_host_port_prefix(host='yy', port=80),
'http://yy')
self.assertEqual(
auth.scheme_host_port_prefix(host='yy', port=81, prefix='x'),
'http://yy:81/x')
self.assertEqual(
auth.scheme_host_port_prefix(scheme='https', host='z1', port=443),
'https://z1')
self.assertEqual(
auth.scheme_host_port_prefix(scheme='https', host='z2', port=444),
'https://z2:444')
def test14_access_cooked_valid(self):
"""Test access_cooked_valid()."""
auth = IIIFAuth()
now = int(time.time())
# No allowed cookies stored, so reject
self.assertFalse(auth.access_cookie_valid('a-cookie', 'testy'))
# Wrong cookie, so reject
auth.access_cookies['cookie1'] = now
self.assertFalse(auth.access_cookie_valid('cookie2', 'testy'))
# Right cookie, recent, so accept
self.assertTrue(auth.access_cookie_valid('cookie1', 'testy'))
# Make cookie old, so reject
auth.access_cookies['cookie1'] = now - auth.access_cookie_lifetime - 2
self.assertFalse(auth.access_cookie_valid('cookie1', 'testy'))
self.assertEqual(len(auth.access_cookies), 1)
# Make cookie very old, so deleted
auth.access_cookies['cookie1'] = now - 2 * auth.access_cookie_lifetime - 2
self.assertFalse(auth.access_cookie_valid('cookie1', 'testy'))
self.assertEqual(len(auth.access_cookies), 0)
def test04_login_service_description(self):
"""Test login_service_description."""
auth = IIIFAuth()
lsd = auth.login_service_description()
self.assertEqual(lsd['profile'], 'http://iiif.io/api/auth/0/login')
auth.login_uri = 'id1'
auth.profile_base = 'http://pb1/'
lsd = auth.login_service_description()
self.assertEqual(lsd['@id'], 'id1')
self.assertEqual(lsd['profile'], 'http://pb1/login')
def test04_login_service_description(self):
"""Test login_service_description."""
auth = IIIFAuth()
lsd = auth.login_service_description()
self.assertEqual(lsd['profile'], 'http://iiif.io/api/auth/1/login')
auth.login_uri = 'id1'
auth.profile_base = 'http://pb1/'
lsd = auth.login_service_description()
self.assertEqual(lsd['@id'], 'id1')
self.assertEqual(lsd['profile'], 'http://pb1/login')
# Addition of auth_type in label
auth.auth_type = "my-auth"
lsd = auth.login_service_description()
self.assertIn('(my-auth)', lsd['label'])
def test13_access_cookie(self):
"""Test access_cookie()."""
auth = IIIFAuth()
auth.account_allowed = mock.Mock(return_value=True)
cookie = auth.access_cookie('abc')
self.assertTrue(cookie)
self.assertIn(cookie, auth.access_cookies)
auth.account_allowed = mock.Mock(return_value=False)
cookie = auth.access_cookie('abc')
self.assertEqual(cookie, None)
self.assertEqual(len(auth.access_cookies), 1)
def test04_login_and_client_id(self):
"""Test login and client id."""
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.login_uri = 'http://example.com/login'
auth.client_id_uri = 'http://example.com/client_id'
auth.add_services(info)
self.assertEqual(info.service['@id'], "http://example.com/login")
self.assertEqual(info.service['label'], "Login to image server")
self.assertEqual(info.service['profile'],
"http://iiif.io/api/auth/1/login")
svcs = info.service['service']
self.assertEqual(svcs['@id'], "http://example.com/client_id")
self.assertEqual(svcs['profile'], "http://iiif.io/api/auth/1/clientId")
def test05_login_and_access_token(self):
"""Test login and access token."""
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.login_uri = 'http://example.com/login'
auth.access_token_uri = 'http://example.com/token'
auth.add_services(info)
self.assertEqual(info.service['@id'], "http://example.com/login")
self.assertEqual(info.service['label'], "Login to image server")
self.assertEqual(info.service['profile'],
"http://iiif.io/api/auth/1/login")
svcs = info.service['service']
self.assertEqual(svcs['@id'], "http://example.com/token")
self.assertEqual(svcs['profile'], "http://iiif.io/api/auth/1/token")
def test03_login_and_logout(self):
"""Test login and logout."""
info = IIIFInfo(identifier="http://example.com/i1", api_version='2.1')
auth = IIIFAuth()
auth.login_uri = 'http://example.com/login'
auth.logout_uri = 'http://example.com/logout'
auth.add_services(info)
self.assertEqual(info.service['@id'], "http://example.com/login")
self.assertEqual(info.service['label'], "Login to image server")
self.assertEqual(info.service['profile'],
"http://iiif.io/api/auth/0/login")
svcs = info.service['service']
self.assertEqual(svcs['@id'], "http://example.com/logout")
self.assertEqual(svcs['label'], "Logout from image server")
self.assertEqual(svcs['profile'], "http://iiif.io/api/auth/0/logout")
def test10_null_handlers(self):
"""Test null handlers."""
self.assertEqual(IIIFAuth().access_token_handler, None)
self.assertEqual(IIIFAuth().client_id_handler, None)
self.assertEqual(IIIFAuth().home_handler, None)
def test03_add_services(self):
"""Test add_services."""
info = IIIFInfo()
auth = IIIFAuth()
self.assertEqual(info.service, None)
# first just login
auth.add_services(info)
self.assertEqual(info.service, None)
auth.login_uri = 'Xlogin'
auth.add_services(info)
self.assertEqual(info.service['@id'], 'Xlogin')
# then login and logout
info = IIIFInfo()
auth = IIIFAuth()
auth.login_uri = 'Xlogin'
auth.logout_uri = 'Ylogout'
auth.add_services(info)
self.assertEqual(info.service['service']['@id'], 'Ylogout')
# now add all, check we have all @ids in service description
info = IIIFInfo()
auth = IIIFAuth()
auth.login_uri = 'Zlogin'
auth.logout_uri = 'Zlogout'
auth.client_id_uri = 'Zclient'
auth.access_token_uri = 'Ztoken'
auth.add_services(info)
self.assertEqual(info.service['@id'], 'Zlogin')
self.assertEqual(len(info.service['service']), 3)
ids = set([e['@id'] for e in info.service['service']])
self.assertEqual(
ids,
set([auth.logout_uri, auth.client_id_uri, auth.access_token_uri]))
def test03_add_services(self):
info = IIIFInfo()
auth = IIIFAuth()
self.assertEqual( info.service, None )
# first just login
auth.add_services(info)
self.assertEqual( info.service, None )
auth.login_uri = 'Xlogin'
auth.add_services(info)
self.assertEqual( info.service['@id'], 'Xlogin' )
# then login and logout
info = IIIFInfo()
auth = IIIFAuth()
auth.login_uri = 'Xlogin'
auth.logout_uri = 'Ylogout'
auth.add_services(info)
self.assertEqual( info.service['service']['@id'], 'Ylogout' )
# now add all, check we have all @ids in service description
info = IIIFInfo()
auth = IIIFAuth()
auth.login_uri = 'Zlogin'
auth.logout_uri = 'Zlogout'
auth.client_id_uri = 'Zclient'
auth.access_token_uri = 'Ztoken'
auth.add_services(info)
self.assertEqual( info.service['@id'], 'Zlogin' )
self.assertEqual( len(info.service['service']), 3 )
ids = set([ e['@id'] for e in info.service['service'] ])
self.assertEqual( ids, set([auth.logout_uri,auth.client_id_uri,auth.access_token_uri]) )