View Source Lightning.VersionControl.GithubToken (Lightning v2.10.4)
A module that uses Joken to handle building and signing application
tokens for communicating with github
Summary
Functions
Combines generate_claims/1 and encode_and_sign/2
Same as generate_and_sign/2 but raises if error
Combines verify/2 and validate/2
Same as verify_and_validate/2 but raises if error
Functions
@spec build(cert :: String.t(), app_id :: String.t()) :: {:ok, Joken.bearer_token(), Joken.claims()} | {:error, Joken.error_reason()}
Link to this function
generate_and_sign(extra_claims \\ %{}, key \\ __default_signer__())
View Source@spec generate_and_sign(Joken.claims(), Joken.signer_arg()) :: {:ok, Joken.bearer_token(), Joken.claims()} | {:error, Joken.error_reason()}
Combines generate_claims/1 and encode_and_sign/2
Link to this function
generate_and_sign!(extra_claims \\ %{}, key \\ __default_signer__())
View Source@spec generate_and_sign!(Joken.claims(), Joken.signer_arg()) :: Joken.bearer_token()
Same as generate_and_sign/2 but raises if error
Link to this function
verify_and_validate(bearer_token, key \\ __default_signer__(), context \\ %{})
View Source@spec verify_and_validate(Joken.bearer_token(), Joken.signer_arg(), term()) :: {:ok, Joken.claims()} | {:error, Joken.error_reason()}
Combines verify/2 and validate/2
Link to this function
verify_and_validate!(bearer_token, key \\ __default_signer__(), context \\ %{})
View Source@spec verify_and_validate!(Joken.bearer_token(), Joken.signer_arg(), term()) :: Joken.claims()
Same as verify_and_validate/2 but raises if error