refactor!: Rename the 'require_expiracy' option to 'require_expiry'

Author: AgathaSorceress

README.md

@@ -33,10 +33,10 @@ keyfile: path to asymetrical keyfile
 #algorithm: HS512
 # Allow registration of new users using these tokens, defaults to false
 #allow_registration: false
-# Require tokens to have an expiracy set, defaults to true
-#require_expiracy: true
+# Require tokens to have an expiry set, defaults to true
+#require_expiry: true
 ```
-It is recommended to have `require_expiracy` set to `true` (default). As for `allow_registration`, it depends on usecase: If you only want to be able to log in *existing* users, leave it at `false` (default). If nonexistant users should be simply registered upon hitting the login endpoint, set it to `true`.
+It is recommended to have `require_expiry` set to `true` (default). As for `allow_registration`, it depends on usecase: If you only want to be able to log in *existing* users, leave it at `false` (default). If nonexistant users should be simply registered upon hitting the login endpoint, set it to `true`.
 
 ## Usage
 First you have to generate a JWT with the correct claims. The `sub` claim is the localpart or full mxid of the user you want to log in as. Be sure that the algorithm and secret match those of the configuration. An example of the claims is as follows:

synapse_token_authenticator/token_authenticator.py

@@ -71,7 +71,7 @@ async def check_auth(
         token = login_dict["token"]
 
         check_claims = {}
-        if self.config.require_expiracy:
+        if self.config.require_expiry:
             check_claims["exp"] = None
         try:
             # OK, let's verify the token
@@ -177,5 +177,5 @@ class _TokenAuthenticatorConfig(object):
             raise Exception("Unknown algorithm " + _config.algorithm)
 
         _config.allow_registration = config.get("allow_registration", False)
-        _config.require_expiracy = config.get("require_expiracy", True)
+        _config.require_expiry = config.get("require_expiry", True)
         return _config

tests/test_simple.py

@@ -61,19 +61,19 @@ async def test_token_expired(self):
         )
         self.assertEqual(result, None)
 
-    async def test_token_no_expiracy(self):
+    async def test_token_no_expiry(self):
         auth_provider = get_auth_provider()
         token = get_token("alice", exp_in=-1)
         result = await auth_provider.check_auth(
             "alice", "com.famedly.login.token", {"token": token}
         )
         self.assertEqual(result, None)
 
-    async def test_token_no_expiracy_with_config(self):
+    async def test_token_no_expiry_with_config(self):
         auth_provider = get_auth_provider(
             config={
                 "secret": "foxies",
-                "require_expiracy": False,
+                "require_expiry": False,
             }
         )
         token = get_token("alice", exp_in=-1)