jose_curve448 behaviour (JOSE v1.11.12)

View Source

Summary

Types

context/0

-type context() :: binary().

eddsa_public_key/0

-type eddsa_public_key() :: <<_:456>>.

eddsa_secret_key/0

-type eddsa_secret_key() :: <<_:912>>.

eddsa_seed/0

-type eddsa_seed() :: <<_:456>>.

maybe_invalid_signature/0

-type maybe_invalid_signature() :: signature() | binary().

message/0

-type message() :: binary().

signature/0

-type signature() :: <<_:912>>.

x448_public_key/0

-type x448_public_key() :: <<_:448>>.

x448_secret_key/0

-type x448_secret_key() :: <<_:448>>.

x448_seed/0

-type x448_seed() :: <<_:448>>.

x448_shared_secret/0

-type x448_shared_secret() :: <<_:448>>.

Callbacks

ed448_sign/2

-callback ed448_sign(Message :: message(), SecretKey :: eddsa_secret_key()) -> Signature :: signature().

ed448_sign/3

-callback ed448_sign(Message :: message(), SecretKey :: eddsa_secret_key(), Context :: context()) ->
                        Signature :: signature().

ed448_verify/3

-callback ed448_verify(Signature :: maybe_invalid_signature(),
                       Message :: message(),
                       PublicKey :: eddsa_public_key()) ->
                          boolean().

ed448_verify/4

-callback ed448_verify(Signature :: maybe_invalid_signature(),
                       Message :: message(),
                       PublicKey :: eddsa_public_key(),
                       Context :: context()) ->
                          boolean().

ed448ph_sign/2

-callback ed448ph_sign(Message :: message(), SecretKey :: eddsa_secret_key()) -> Signature :: signature().

ed448ph_sign/3

-callback ed448ph_sign(Message :: message(), SecretKey :: eddsa_secret_key(), Context :: context()) ->
                          Signature :: signature().

ed448ph_verify/3

-callback ed448ph_verify(Signature :: maybe_invalid_signature(),
                         Message :: message(),
                         PublicKey :: eddsa_public_key()) ->
                            boolean().

ed448ph_verify/4

-callback ed448ph_verify(Signature :: maybe_invalid_signature(),
                         Message :: message(),
                         PublicKey :: eddsa_public_key(),
                         Context :: context()) ->
                            boolean().

eddsa_keypair/0

-callback eddsa_keypair() -> {PublicKey :: eddsa_public_key(), SecretKey :: eddsa_secret_key()}.

eddsa_keypair/1

-callback eddsa_keypair(Seed :: eddsa_seed()) ->
                           {PublicKey :: eddsa_public_key(), SecretKey :: eddsa_secret_key()}.

eddsa_secret_to_public/1

-callback eddsa_secret_to_public(SecretKey :: eddsa_secret_key()) -> PublicKey :: eddsa_public_key().

x448_keypair/0

-callback x448_keypair() -> {PublicKey :: eddsa_public_key(), SecretKey :: eddsa_secret_key()}.

x448_keypair/1

-callback x448_keypair(Seed :: x448_seed()) ->
                          {PublicKey :: x448_public_key(), SecretKey :: x448_secret_key()}.

x448_secret_to_public/1

-callback x448_secret_to_public(SecretKey :: x448_secret_key()) -> PublicKey :: x448_public_key().

x448_shared_secret/2

-callback x448_shared_secret(MySecretKey :: x448_secret_key(), YourPublicKey :: x448_public_key()) ->
                                SharedSecret :: x448_shared_secret().

Functions

ed448_sign(Message, SecretKey)

-spec ed448_sign(message(), eddsa_secret_key()) -> signature().

ed448_sign(Message, SecretKey, Context)

-spec ed448_sign(message(), eddsa_secret_key(), context()) -> signature().

ed448_verify(Signature, Message, PublicKey)

-spec ed448_verify(maybe_invalid_signature(), message(), eddsa_public_key()) -> boolean().

ed448_verify(Signature, Message, PublicKey, Context)

-spec ed448_verify(maybe_invalid_signature(), message(), eddsa_public_key(), context()) -> boolean().

ed448ph_sign(Message, SecretKey)

-spec ed448ph_sign(message(), eddsa_secret_key()) -> signature().

ed448ph_sign(Message, SecretKey, Context)

-spec ed448ph_sign(message(), eddsa_secret_key(), context()) -> signature().

ed448ph_verify(Signature, Message, PublicKey)

-spec ed448ph_verify(maybe_invalid_signature(), message(), eddsa_public_key()) -> boolean().

ed448ph_verify(Signature, Message, PublicKey, Context)

-spec ed448ph_verify(maybe_invalid_signature(), message(), eddsa_public_key(), context()) -> boolean().

eddsa_keypair()

-spec eddsa_keypair() -> {eddsa_public_key(), eddsa_secret_key()}.

eddsa_keypair(Seed)

-spec eddsa_keypair(eddsa_seed()) -> {eddsa_public_key(), eddsa_secret_key()}.

eddsa_secret_to_public(SecretKey)

-spec eddsa_secret_to_public(eddsa_secret_key()) -> eddsa_public_key().

x448_keypair()

-spec x448_keypair() -> {x448_public_key(), x448_secret_key()}.

x448_keypair(Seed)

-spec x448_keypair(x448_seed()) -> {x448_public_key(), x448_secret_key()}.

x448_secret_to_public(SecretKey)

-spec x448_secret_to_public(x448_secret_key()) -> x448_public_key().

x448_shared_secret(MySecretKey, YourPublicKey)

-spec x448_shared_secret(MySecretKey :: x448_secret_key(), YourPublicKey :: x448_public_key()) ->
                            x448_shared_secret().