Nucypher
/
pyUmbral
mirror of https://github.com/nucypher/pyUmbral.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
pyUmbral/docs/source/api.rst

90 lines
1.7 KiB
ReStructuredText
Raw Permalink Normal View History

Add some API docs
2021-03-21 03:06:03 +00:00
Public API
==========
.. automodule:: umbral
Keys
----
.. autoclass:: SecretKey()
:members:
:show-inheritance:
.. autoclass:: PublicKey()
:members:
:special-members: __eq__, __hash__
:show-inheritance:
.. autoclass:: SecretKeyFactory()
:members:
:show-inheritance:
Move SecretKey signing capabilities to a Signer class
2021-04-19 04:34:26 +00:00
.. autoclass:: Signer
:members:
Resolve circular dependency keys-signing-hashing Have to regenerate the vectors because kfrag signature is now created with a different DST
2021-04-19 05:08:46 +00:00
.. autoclass:: Signature()
:members:
:special-members: __eq__, __hash__
:show-inheritance:
Add some API docs
2021-03-21 03:06:03 +00:00
Intermediate objects
--------------------
.. autoclass:: Capsule()
:special-members: __eq__, __hash__
:show-inheritance:
.. autoclass:: KeyFrag()
:members: verify
:special-members: __eq__, __hash__
:show-inheritance:
Enforce KeyFrag verification before reencryption
2021-04-20 00:53:32 +00:00
.. autoclass:: VerifiedKeyFrag()
Add VerifiedKeyFrag.from_verified_bytes() for the purposes of Nucypher's datastore
2021-06-02 06:55:48 +00:00
:members:
Enforce KeyFrag verification before reencryption
2021-04-20 00:53:32 +00:00
:special-members: __eq__, __hash__
Split Serializable into (De)Serializable
2021-06-03 21:34:03 +00:00
:show-inheritance:
Enforce KeyFrag verification before reencryption
2021-04-20 00:53:32 +00:00
Add some API docs
2021-03-21 03:06:03 +00:00
.. autoclass:: CapsuleFrag()
Add a TODO in CapsuleFrag.verify() and bail early if the signature is not correct
2021-05-18 21:05:27 +00:00
:members:
Add some API docs
2021-03-21 03:06:03 +00:00
:special-members: __eq__, __hash__
:show-inheritance:
Enforce CapsuleFrag verification before decryption
2021-04-20 01:53:16 +00:00
.. autoclass:: VerifiedCapsuleFrag()
Add `VerifiedCapsuleFrag.from_verified_bytes()`
2021-07-19 21:24:58 +00:00
:members:
Enforce CapsuleFrag verification before decryption
2021-04-20 01:53:16 +00:00
:special-members: __eq__, __hash__
Split Serializable into (De)Serializable
2021-06-03 21:34:03 +00:00
:show-inheritance:
Enforce CapsuleFrag verification before decryption
2021-04-20 01:53:16 +00:00
Add some API docs
2021-03-21 03:06:03 +00:00
Encryption, re-encryption and decryption
----------------------------------------
.. autofunction:: encrypt
.. autofunction:: decrypt_original
.. autofunction:: generate_kfrags
.. autofunction:: reencrypt
.. autofunction:: decrypt_reencrypted
Utilities
---------
Enforce KeyFrag verification before reencryption
2021-04-20 00:53:32 +00:00
.. autoclass:: umbral.VerificationError
:show-inheritance:
Split Serializable into (De)Serializable
2021-06-03 21:34:03 +00:00
.. autoclass:: umbral.serializable.HasSerializedSize
Make SecretKey and SecretKeyFactory serializable via `to_secret_bytes()` instead of `bytes()`
2021-07-19 22:08:29 +00:00
:members:
Split Serializable into (De)Serializable
2021-06-03 21:34:03 +00:00
Add some API docs
2021-03-21 03:06:03 +00:00
.. autoclass:: umbral.serializable.Serializable
:special-members: __bytes__
Split Serializable into (De)Serializable
2021-06-03 21:34:03 +00:00
:show-inheritance:
Make SecretKey and SecretKeyFactory serializable via `to_secret_bytes()` instead of `bytes()`
2021-07-19 22:08:29 +00:00
.. autoclass:: umbral.serializable.SerializableSecret
:members:
:show-inheritance:
Split Serializable into (De)Serializable
2021-06-03 21:34:03 +00:00
.. autoclass:: umbral.serializable.Deserializable
Make SecretKey and SecretKeyFactory serializable via `to_secret_bytes()` instead of `bytes()`
2021-07-19 22:08:29 +00:00
:members:
Split Serializable into (De)Serializable
2021-06-03 21:34:03 +00:00
:show-inheritance: