synology_apm_repo.sdk.api.key_manager module¶
KeyManager: one opened Repository’s encryption-key state
(keys/key_verification/encrypted) and the KeyStatus it
resolves to.
- class synology_apm_repo.sdk.api.key_manager.KeyStatus(*values)¶
Bases:
EnumA repository’s key state.
NO_KEY_PROVIDEDmeans encrypted (or, rarely, undeterminable) with no key tried yet;INVALIDmeans the last key tried was rejected.- NO_KEY_PROVIDED = 'no_key_provided'¶
- NOT_ENCRYPTED = 'not_encrypted'¶
- VERIFIED = 'verified'¶
- INVALID = 'invalid'¶
- class synology_apm_repo.sdk.api.key_manager.KeyManager(keys, key_verification, *, encrypted=None)¶
Bases:
objectOne
Repository’s encryption-key state.Repository.set_key()sequencesverify()/adopt()/record().- property keys: KeyMaterial | None¶
The adopted key material;
Noneuntil a key is supplied at construction oradopt()-ed. A rejected key is never adopted.
- property verification: KeyVerification | None¶
The GCM-unwrap verification result, or
Nonewhen no key was ever provided — the detail behindstatus’sINVALID/VERIFIED.
- property is_encrypted: bool | None¶
Whether this repository is encrypted,
Trueeven when the key was rejected;Nonewhen the probe couldn’t tell.
- require_verified()¶
Check, before workload/version I/O, that a confirmed-encrypted repository has a verified key.
- Raises:
KeyRequiredError – The repository is encrypted and no key was supplied.
KeyMismatchError – The last key supplied was rejected.
- async verify(store, layout, key_string)¶
KeyMaterialfromkey_string, verified againstlayout’s key-probe location. Leaves this manager’s state unchanged.- Raises:
KeyMaterialError –
key_stringis malformed.DataCorruptError – The repository’s key record is unreadable.
- adopt(keys)¶
Make
keysthe key material catalogs open with from now on.status/verificationchange only onrecord().
- record(keys, verification)¶
Record
verificationand recomputestatus.keysis the key just tried, adopted or not, so a rejected key still yieldsINVALIDrather thanNO_KEY_PROVIDED.
- synology_apm_repo.sdk.api.key_manager.validate_key_string(key_string)¶
Check
key_stringis a well-formed"<userKeyID>@<base64 userKey>"without opening anything, e.g. while a command line is read.- Raises:
KeyMaterialError – It is malformed. The message never repeats the secret
userKey.