README.md

@@ -287,14 +287,12 @@ After first success you have to replace `--issue` with `--renew`.
 | `DLS_PORT`          | `443`                                  | Used in client-token to tell guest driver where dls instance is reachable           |
 | `LEASE_EXPIRE_DAYS` | `90`                                   | Lease time in days                                                                  |
 | `DATABASE`          | `sqlite:///db.sqlite`                  | See [official SQLAlchemy docs](https://docs.sqlalchemy.org/en/14/core/engines.html) |
-| `CORS_ORIGINS`      | `https://{DLS_URL}`                    | Sets `Access-Control-Allow-Origin` header (comma separated string) \*               |
+| `CORS_ORIGINS`      | `https://{DLS_URL}`                    | Sets `Access-Control-Allow-Origin` header (comma separated string)                  |
 | `SITE_KEY_XID`      | `00000000-0000-0000-0000-000000000000` | Site identification uuid                                                            |
 | `INSTANCE_REF`      | `00000000-0000-0000-0000-000000000000` | Instance identification uuid                                                        |
 | `INSTANCE_KEY_RSA`  | `<app-dir>/cert/instance.private.pem`  | Site-wide private RSA key for singing JWTs                                          |
 | `INSTANCE_KEY_PUB`  | `<app-dir>/cert/instance.public.pem`   | Site-wide public key                                                                |
 
-\* Always use `https`, since guest-drivers only support secure connections!
-
 # Setup (Client)
 
 **The token file has to be copied! It's not enough to C&P file contents, because there can be special characters.**

app/main.py

@@ -40,7 +40,8 @@ INSTANCE_KEY_RSA = load_key(str(env('INSTANCE_KEY_RSA', join(dirname(__file__),
 INSTANCE_KEY_PUB = load_key(str(env('INSTANCE_KEY_PUB', join(dirname(__file__), 'cert/instance.public.pem'))))
 TOKEN_EXPIRE_DELTA = relativedelta(hours=1)  # days=1
 LEASE_EXPIRE_DELTA = relativedelta(days=int(env('LEASE_EXPIRE_DAYS', 90)))
-CORS_ORIGINS = env('CORS_ORIGINS').split(',') if (env('CORS_ORIGINS')) else f'https://{DLS_URL}'
+
+CORS_ORIGINS = env('CORS_ORIGINS').split(',') if (env('CORS_ORIGINS')) else f'https://{DLS_URL}'  # todo: prevent static https
 
 jwt_encode_key = jwk.construct(INSTANCE_KEY_RSA.export_key().decode('utf-8'), algorithm=ALGORITHMS.RS256)
 jwt_decode_key = jwk.construct(INSTANCE_KEY_PUB.export_key().decode('utf-8'), algorithm=ALGORITHMS.RS256)
@@ -50,34 +51,29 @@ app.add_middleware(
     CORSMiddleware,
     allow_origins=CORS_ORIGINS,
     allow_credentials=True,
-    allow_methods=['*'],
-    allow_headers=['*'],
+    allow_methods=["*"],
+    allow_headers=["*"],
 )
 
 logger.setLevel(logging.DEBUG if DEBUG else logging.INFO)
 
 
-def __get_token(request: Request) -> dict:
-    authorization_header = request.headers.get('authorization')
+def get_token(request: Request) -> dict:
+    authorization_header = request.headers['authorization']
     token = authorization_header.split(' ')[1]
     return jwt.decode(token=token, key=jwt_decode_key, algorithms=ALGORITHMS.RS256, options={'verify_aud': False})
 
 
-@app.get('/', summary='Index')
+@app.get('/', summary='* Index')
 async def index():
     return RedirectResponse('/-/readme')
 
 
-@app.get('/status', summary='* Status', description='returns current service status, version (incl. git-commit) and some variables.', deprecated=True)
+@app.get('/status', summary='* Status', description='Returns current service status, version (incl. git-commit) and some variables.', deprecated=True)
 async def status(request: Request):
     return JSONResponse({'status': 'up', 'version': VERSION, 'commit': COMMIT, 'debug': DEBUG})
 
 
-@app.get('/-/', summary='* Index')
-async def _index():
-    return RedirectResponse('/-/readme')
-
-
 @app.get('/-/health', summary='* Health')
 async def _health(request: Request):
     return JSONResponse({'status': 'up', 'version': VERSION, 'commit': COMMIT, 'debug': DEBUG})
@@ -165,8 +161,8 @@ async def _lease_delete(request: Request, lease_ref: str):
 
 
 # venv/lib/python3.9/site-packages/nls_core_service_instance/service_instance_token_manager.py
-@app.get('/-/client-token', summary='* Client-Token', description='creates a new messenger token for this service instance')
-async def _client_token():
+@app.get('/client-token', summary='* Client-Token')
+async def client_token():
     cur_time = datetime.utcnow()
     exp_time = cur_time + relativedelta(years=12)
 
@@ -210,14 +206,9 @@ async def _client_token():
     return response
 
 
-@app.get('/client-token', summary='* Client-Token', description='creates a new messenger token for this service instance', deprecated=True)
-async def client_token():
-    return RedirectResponse('/-/client-token')
-
-
 # venv/lib/python3.9/site-packages/nls_services_auth/test/test_origins_controller.py
 # {"candidate_origin_ref":"00112233-4455-6677-8899-aabbccddeeff","environment":{"fingerprint":{"mac_address_list":["ff:ff:ff:ff:ff:ff"]},"hostname":"my-hostname","ip_address_list":["192.168.178.123","fe80::","fe80::1%enp6s18"],"guest_driver_version":"510.85.02","os_platform":"Debian GNU/Linux 11 (bullseye) 11","os_version":"11 (bullseye)"},"registration_pending":false,"update_pending":false}
-@app.post('/auth/v1/origin', description='find or create an origin')
+@app.post('/auth/v1/origin')
 async def auth_v1_origin(request: Request):
     j, cur_time = json.loads((await request.body()).decode('utf-8')), datetime.utcnow()
 
@@ -248,7 +239,7 @@ async def auth_v1_origin(request: Request):
 
 # venv/lib/python3.9/site-packages/nls_services_auth/test/test_origins_controller.py
 # { "environment" : { "guest_driver_version" : "guest_driver_version", "hostname" : "myhost", "ip_address_list" : [ "192.168.1.129" ], "os_version" : "os_version", "os_platform" : "os_platform", "fingerprint" : { "mac_address_list" : [ "e4:b9:7a:e5:7b:ff" ] }, "host_driver_version" : "host_driver_version" }, "origin_ref" : "00112233-4455-6677-8899-aabbccddeeff" }
-@app.post('/auth/v1/origin/update', description='update an origin evidence')
+@app.post('/auth/v1/origin/update')
 async def auth_v1_origin_update(request: Request):
     j, cur_time = json.loads((await request.body()).decode('utf-8')), datetime.utcnow()
 
@@ -276,7 +267,7 @@ async def auth_v1_origin_update(request: Request):
 # venv/lib/python3.9/site-packages/nls_services_auth/test/test_auth_controller.py
 # venv/lib/python3.9/site-packages/nls_core_auth/auth.py - CodeResponse
 # {"code_challenge":"...","origin_ref":"00112233-4455-6677-8899-aabbccddeeff"}
-@app.post('/auth/v1/code', description='get an authorization code')
+@app.post('/auth/v1/code')
 async def auth_v1_code(request: Request):
     j, cur_time = json.loads((await request.body()).decode('utf-8')), datetime.utcnow()
 
@@ -309,7 +300,7 @@ async def auth_v1_code(request: Request):
 # venv/lib/python3.9/site-packages/nls_services_auth/test/test_auth_controller.py
 # venv/lib/python3.9/site-packages/nls_core_auth/auth.py - TokenResponse
 # {"auth_code":"...","code_verifier":"..."}
-@app.post('/auth/v1/token', description='exchange auth code and verifier for token')
+@app.post('/auth/v1/token')
 async def auth_v1_token(request: Request):
     j, cur_time = json.loads((await request.body()).decode('utf-8')), datetime.utcnow()
     payload = jwt.decode(token=j['auth_code'], key=jwt_decode_key)
@@ -346,11 +337,11 @@ async def auth_v1_token(request: Request):
 
 
 # {'fulfillment_context': {'fulfillment_class_ref_list': []}, 'lease_proposal_list': [{'license_type_qualifiers': {'count': 1}, 'product': {'name': 'NVIDIA RTX Virtual Workstation'}}], 'proposal_evaluation_mode': 'ALL_OF', 'scope_ref_list': ['00112233-4455-6677-8899-aabbccddeeff']}
-@app.post('/leasing/v1/lessor', description='request multiple leases (borrow) for current origin')
+@app.post('/leasing/v1/lessor')
 async def leasing_v1_lessor(request: Request):
-    j, token, cur_time = json.loads((await request.body()).decode('utf-8')), __get_token(request), datetime.utcnow()
+    j, token, cur_time = json.loads((await request.body()).decode('utf-8')), get_token(request), datetime.utcnow()
 
-    origin_ref = token.get('origin_ref')
+    origin_ref = token['origin_ref']
     scope_ref_list = j['scope_ref_list']
     logging.info(f'> [  create  ]: {origin_ref}: create leases for scope_ref_list {scope_ref_list}')
 
@@ -386,11 +377,11 @@ async def leasing_v1_lessor(request: Request):
 
 # venv/lib/python3.9/site-packages/nls_services_lease/test/test_lease_multi_controller.py
 # venv/lib/python3.9/site-packages/nls_dal_service_instance_dls/schema/service_instance/V1_0_21__product_mapping.sql
-@app.get('/leasing/v1/lessor/leases', description='get active leases for current origin')
+@app.get('/leasing/v1/lessor/leases')
 async def leasing_v1_lessor_lease(request: Request):
-    token, cur_time = __get_token(request), datetime.utcnow()
+    token, cur_time = get_token(request), datetime.utcnow()
 
-    origin_ref = token.get('origin_ref')
+    origin_ref = token['origin_ref']
 
     active_lease_list = list(map(lambda x: x.lease_ref, Lease.find_by_origin_ref(db, origin_ref)))
     logging.info(f'> [  leases  ]: {origin_ref}: found {len(active_lease_list)} active leases')
@@ -405,11 +396,11 @@ async def leasing_v1_lessor_lease(request: Request):
 
 
 # venv/lib/python3.9/site-packages/nls_core_lease/lease_single.py
-@app.put('/leasing/v1/lease/{lease_ref}', description='renew a lease')
+@app.put('/leasing/v1/lease/{lease_ref}')
 async def leasing_v1_lease_renew(request: Request, lease_ref: str):
-    token, cur_time = __get_token(request), datetime.utcnow()
+    token, cur_time = get_token(request), datetime.utcnow()
 
-    origin_ref = token.get('origin_ref')
+    origin_ref = token['origin_ref']
     logging.info(f'> [  renew   ]: {origin_ref}: renew {lease_ref}')
 
     entity = Lease.find_by_origin_ref_and_lease_ref(db, origin_ref, lease_ref)
@@ -431,36 +422,11 @@ async def leasing_v1_lease_renew(request: Request, lease_ref: str):
     return JSONResponse(response)
 
 
-@app.delete('/leasing/v1/lease/{lease_ref}', description='release (return) a lease')
-async def leasing_v1_lease_delete(request: Request, lease_ref: str):
-    token, cur_time = __get_token(request), datetime.utcnow()
-
-    origin_ref = token.get('origin_ref')
-    logging.info(f'> [  return  ]: {origin_ref}: return {lease_ref}')
-
-    entity = Lease.find_by_lease_ref(db, lease_ref)
-    if entity.origin_ref != origin_ref:
-        raise HTTPException(status_code=403, detail='access or operation forbidden')
-    if entity is None:
-        raise HTTPException(status_code=404, detail='requested lease not available')
-
-    if Lease.delete(db, lease_ref) == 0:
-        raise HTTPException(status_code=404, detail='lease not found')
-
-    response = {
-        "lease_ref": lease_ref,
-        "prompts": None,
-        "sync_timestamp": cur_time.isoformat(),
-    }
-
-    return JSONResponse(response)
-
-
-@app.delete('/leasing/v1/lessor/leases', description='release all leases')
+@app.delete('/leasing/v1/lessor/leases')
 async def leasing_v1_lessor_lease_remove(request: Request):
-    token, cur_time = __get_token(request), datetime.utcnow()
+    token, cur_time = get_token(request), datetime.utcnow()
 
-    origin_ref = token.get('origin_ref')
+    origin_ref = token['origin_ref']
 
     released_lease_list = list(map(lambda x: x.lease_ref, Lease.find_by_origin_ref(db, origin_ref)))
     deletions = Lease.cleanup(db, origin_ref)

app/orm.py

@@ -115,13 +115,6 @@ class Lease(Base):
         session.close()
         return entities
 
-    @staticmethod
-    def find_by_lease_ref(engine: Engine, lease_ref: str) -> "Lease":
-        session = sessionmaker(bind=engine)()
-        entity = session.query(Lease).filter(Lease.lease_ref == lease_ref).first()
-        session.close()
-        return entity
-
     @staticmethod
     def find_by_origin_ref_and_lease_ref(engine: Engine, origin_ref: str, lease_ref: str) -> "Lease":
         session = sessionmaker(bind=engine)()
@@ -132,7 +125,7 @@ class Lease(Base):
     @staticmethod
     def renew(engine: Engine, lease: "Lease", lease_expires: datetime.datetime, lease_updated: datetime.datetime):
         session = sessionmaker(bind=engine)()
-        x = dict(lease_expires=lease_expires, lease_updated=lease_updated)
+        x = dict(lease_expires=lease.lease_expires, lease_updated=lease.lease_updated)
         session.execute(update(Lease).where(and_(Lease.origin_ref == lease.origin_ref, Lease.lease_ref == lease.lease_ref)).values(**x))
         session.commit()
         session.close()

app/util.py

@@ -1,28 +1,21 @@
+try:
+    # Crypto | Cryptodome on Debian
+    from Crypto.PublicKey import RSA
+    from Crypto.PublicKey.RSA import RsaKey
+except ModuleNotFoundError:
+    from Cryptodome.PublicKey import RSA
+    from Cryptodome.PublicKey.RSA import RsaKey
+
+
 def load_file(filename) -> bytes:
     with open(filename, 'rb') as file:
         content = file.read()
     return content
 
 
-def load_key(filename) -> "RsaKey":
-    try:
-        # Crypto | Cryptodome on Debian
-        from Crypto.PublicKey import RSA
-        from Crypto.PublicKey.RSA import RsaKey
-    except ModuleNotFoundError:
-        from Cryptodome.PublicKey import RSA
-        from Cryptodome.PublicKey.RSA import RsaKey
-
+def load_key(filename) -> RsaKey:
     return RSA.import_key(extern_key=load_file(filename), passphrase=None)
 
 
-def generate_key() -> "RsaKey":
-    try:
-        # Crypto | Cryptodome on Debian
-        from Crypto.PublicKey import RSA
-        from Crypto.PublicKey.RSA import RsaKey
-    except ModuleNotFoundError:
-        from Cryptodome.PublicKey import RSA
-        from Cryptodome.PublicKey.RSA import RsaKey
-
+def generate_key() -> RsaKey:
     return RSA.generate(bits=2048)

test/main.py

@@ -16,7 +16,7 @@ sys.path.append('../')
 sys.path.append('../app')
 
 from app import main
-from app.util import load_key
+from app.util import generate_key, load_key
 
 client = TestClient(main.app)
 
@@ -33,12 +33,6 @@ jwt_encode_key = jwk.construct(INSTANCE_KEY_RSA.export_key().decode('utf-8'), al
 jwt_decode_key = jwk.construct(INSTANCE_KEY_PUB.export_key().decode('utf-8'), algorithm=ALGORITHMS.RS256)
 
 
-def __bearer_token(origin_ref: str) -> str:
-    token = jwt.encode({"origin_ref": origin_ref}, key=jwt_encode_key, algorithm=ALGORITHMS.RS256)
-    token = f'Bearer {token}'
-    return token
-
-
 def test_index():
     response = client.get('/')
     assert response.status_code == 200
@@ -67,11 +61,6 @@ def test_manage():
 
 
 def test_client_token():
-    response = client.get('/-/client-token')
-    assert response.status_code == 200
-
-
-def test_client_token_deprecated():
     response = client.get('/client-token')
     assert response.status_code == 200
 
@@ -186,7 +175,9 @@ def test_leasing_v1_lessor():
         'scope_ref_list': [LEASE_REF]
     }
 
-    response = client.post('/leasing/v1/lessor', json=payload, headers={'authorization': __bearer_token(ORIGIN_REF)})
+    bearer_token = jwt.encode({"origin_ref": ORIGIN_REF}, key=jwt_encode_key, algorithm=ALGORITHMS.RS256)
+    bearer_token = f'Bearer {bearer_token}'
+    response = client.post('/leasing/v1/lessor', json=payload, headers={'authorization': bearer_token})
     assert response.status_code == 200
 
     lease_result_list = response.json()['lease_result_list']
@@ -195,7 +186,9 @@ def test_leasing_v1_lessor():
 
 
 def test_leasing_v1_lessor_lease():
-    response = client.get('/leasing/v1/lessor/leases', headers={'authorization': __bearer_token(ORIGIN_REF)})
+    bearer_token = jwt.encode({"origin_ref": ORIGIN_REF}, key=jwt_encode_key, algorithm=ALGORITHMS.RS256)
+    bearer_token = f'Bearer {bearer_token}'
+    response = client.get('/leasing/v1/lessor/leases', headers={'authorization': bearer_token})
     assert response.status_code == 200
 
     active_lease_list = response.json()['active_lease_list']
@@ -204,23 +197,18 @@ def test_leasing_v1_lessor_lease():
 
 
 def test_leasing_v1_lease_renew():
-    response = client.put(f'/leasing/v1/lease/{LEASE_REF}', headers={'authorization': __bearer_token(ORIGIN_REF)})
-    assert response.status_code == 200
-
-    assert response.json()['lease_ref'] == LEASE_REF
-
-
-def test_leasing_v1_lease_delete():
-    response = client.delete(f'/leasing/v1/lease/{LEASE_REF}', headers={'authorization': __bearer_token(ORIGIN_REF)})
+    bearer_token = jwt.encode({"origin_ref": ORIGIN_REF}, key=jwt_encode_key, algorithm=ALGORITHMS.RS256)
+    bearer_token = f'Bearer {bearer_token}'
+    response = client.put(f'/leasing/v1/lease/{LEASE_REF}', headers={'authorization': bearer_token})
     assert response.status_code == 200
 
     assert response.json()['lease_ref'] == LEASE_REF
 
 
 def test_leasing_v1_lessor_lease_remove():
-    test_leasing_v1_lessor()
-
-    response = client.delete('/leasing/v1/lessor/leases', headers={'authorization': __bearer_token(ORIGIN_REF)})
+    bearer_token = jwt.encode({"origin_ref": ORIGIN_REF}, key=jwt_encode_key, algorithm=ALGORITHMS.RS256)
+    bearer_token = f'Bearer {bearer_token}'
+    response = client.delete('/leasing/v1/lessor/leases', headers={'authorization': bearer_token})
     assert response.status_code == 200
 
     released_lease_list = response.json()['released_lease_list']