View Source SmeeView.Aspects.SP (SmeeView v0.2.1)

This aspect contains a bundle of related aspects for the SP role of an entity.

Since displaynames, descriptions, URLs, etc are often used together this Aspect exists to make gathering them all a little simpler.

You can extract and process each of the different types of aspects using their own View modules:

Summary

Functions

Returns true if the signs authn requests is set

Lists MDUI displaynames used by this role

Is this aspect relevant to the IdP role?

Lists public keys for this role

Lists MD Disco keyword sets as Keywords aspects

Lists MDUI logos used by this role

Returns a list of protocol aspects for this role

Returns the associated role for this aspect: :sp, :idp or :all

Lists all types of services for this role

Is this aspect relevant to the SP role?

Returns true if the SP wants assertions to besigned

Types

@type t() :: %SmeeView.Aspects.SP{
  authn_requests_signed: boolean(),
  displaynames: list(),
  error_url: nil | binary(),
  keys: list(),
  keywords: list(),
  logos: list(),
  protocols: list(),
  services: list(),
  want_assertions_signed: boolean()
}

Functions

Link to this function

authn_requests_signed?(aspect)

View Source
@spec authn_requests_signed?(aspect :: t()) :: boolean()

Returns true if the signs authn requests is set

SP.authn_requests_signed?(aspect)
# => false
@spec displaynames(aspect :: t()) :: list()

Lists MDUI displaynames used by this role

SP.displaynames(aspect)
# => [%Displayname{}, %Displayname{}, %Displayname{}]
@spec idp?(aspect :: t()) :: boolean()

Is this aspect relevant to the IdP role?

Will return true if the aspect has been derived from an IdP role, or is applicable to all roles.

SP.idp?(aspect)
# => true
@spec keys(aspect :: t()) :: list()

Lists public keys for this role

SP.keys(aspect)
# => [%Key{}, %Key{}]
@spec keywords(aspect :: t()) :: list()

Lists MD Disco keyword sets as Keywords aspects

SP.keywords(aspect)
# => [Keywords{}]
@spec logos(aspect :: t()) :: list()

Lists MDUI logos used by this role

SP.logos(aspect)
# => [Logo{}, Logo{}, Logo{}]
@spec protocols(aspect :: t()) :: list()

Returns a list of protocol aspects for this role

SP.protocols(aspect)
# => [%Protocol{}, %Protocol{}]
@spec role(aspect :: t()) :: atom()

Returns the associated role for this aspect: :sp, :idp or :all

The role type is useful when handling a mixed list of aspects that may be specific to certain roles of an entity.

SP.role(aspect)
# => :idp
@spec services(aspect :: t()) :: list()

Lists all types of services for this role

SP.services(aspect)
# => [%SingleSignOnService{}, %SingleLogoutService{}]
@spec sp?(aspect :: t()) :: boolean()

Is this aspect relevant to the SP role?

Will return true if the aspect has been derived from an SP role, or is applicable to all roles.

SP.sp?(aspect)
# => false
Link to this function

want_assertions_signed?(aspect)

View Source
@spec want_assertions_signed?(aspect :: t()) :: boolean()

Returns true if the SP wants assertions to besigned

SP.want_assertions_signed?(aspect)
# => false