jam.paseto.v3

v3

Classes:

Name	Description
PASETOv3	PASETO v3 factory.

PASETOv3

PASETOv3()

Bases: BasePASETO

PASETO v3 factory.

Methods:

Name	Description
decode	Decode PASETO.
encode	Encode PASETO.
key	Create PASETOv3 instance.

decode

decode(
    token: str,
    serializer: type[BaseEncoder]
    | BaseEncoder = JsonEncoder,
) -> tuple[
    dict[str, Any], dict[str, Any] | str | bytes | None
]

Decode PASETO.

Parameters:

Name	Type	Description	Default
token	str	PASETO	required
serializer	type[BaseEncoder] | BaseEncoder]	JSON serializer	JsonEncoder

Returns:

Type	Description
tuple[dict[str, Any], dict[str, Any] | str | bytes | None]	Payload and dict

encode

encode(
    payload: dict[str, Any],
    footer: dict[str, Any] | str | bytes | None = None,
    serializer: type[BaseEncoder]
    | BaseEncoder = JsonEncoder,
) -> str

Encode PASETO.

Parameters:

Name	Type	Description	Default
payload	dict[str, Any]	Token payload	required
footer	dict[str, Any] | None	Footer if needed	None
serializer	type[BaseEncoder] | BaseEncoder	JSON Serializer	JsonEncoder

Returns:

Name	Type	Description
str	str	Token

key classmethod

key(
    purpose: Literal["local", "public"],
    secret_key: str | bytes,
    public_key: str | bytes | None = None,
) -> PASETO

Create PASETOv3 instance.

Parameters:

Name	Type	Description	Default
purpose	str	"local" or "public"	required
secret_key	str | bytes	Private PEM	required
public_key	str | bytes | None	Public PEM	None