cassette

v1.3.1

cassette v1.3.1 MyCas

Summary

Functions

child_spec()
config()

Returns the configuration used by this Cassette server

st(service)

Generates a Service Ticket for the given service

start(, )

Called when an application is started

tgt()

Generates a Ticket Granting Ticket

validate(ticket, service \\ config().service())

Validates a given ticket against the given service or the service set in the configuration

Functions

child_spec() 
child_spec() :: Supervisor.Spec.spec
config() 
config() :: Cassette.Config.t

Returns the configuration used by this Cassette server

Will return the default configuration if not provided.

Please refer to Cassette.Config.t for details

st(service) 
st(String.t) :: {:ok, String.t} | {:error, term}

Generates a Service Ticket for the given service

This function retries once when the TGT is expired on the server side.

start(, ) 
start(term, term) :: GenServer.on_start

Called when an application is started.

This function is called when an the application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

  • :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another mode and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.

tgt() 
tgt() :: {:ok, String.t} | {:error, term}

Generates a Ticket Granting Ticket

validate(ticket, service \\ config().service()) 
validate(String.t, String.t) ::
  {:ok, Cassette.User.t} |
  {:error, term}

Validates a given ticket against the given service or the service set in the configuration