Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Sustainsys.Saml2.Configuration.Saml2Notifications
Assembly: Sustainsys.Saml2
Inheritance: object → Saml2Notifications
Set of callbacks that can be used as extension points for various events.
Properties
public
System.Action`3
AuthenticationRequestCreated
Notification called when a <see cref="T:Sustainsys.Saml2.Saml2P.Saml2AuthenticationRequest" />
has been created. The authenticationrequest can be amended and
modified.
public
System.Action`3
AuthenticationRequestXmlCreated
public
System.Action`2
SignInCommandResultCreated
Notification called when the SignIn command has produced a
<see cref="T:Sustainsys.Saml2.WebSso.CommandResult" /> , but before anything has been applied
to the outgoing response. Set the <see cref="P:Sustainsys.Saml2.WebSso.CommandResult.HandledResult" />
flag to suppress the library's built in apply functionality to the
outgoing response.
public
System.Func`3
SelectIdentityProvider
Notification called when the SignIn command is about to select
what Idp to use for the request. The EntityId is the one supplied
(e.g. through query string). To select a specicic IdentityProvider
simply return it. Return <code>null</code> to fall back to built
in selection.
public
System.Func`2
EmitSameSiteNone
Notification called to decide if a SameSite=None attribute should
be set for a cookie. The default implementation is based on the pseudo
code in https://devblogs.microsoft.com/aspnet/upcoming-samesite-cookie-changes-in-asp-net-and-asp-net-core/
More covering code can be found at
https://www.chromium.org/updates/same-site/incompatible-clients but that cannot
be shipped with the library due to the license.
public
System.Func`2
GetLogoutResponseState
Notification called when the logout command is about to use the
<code>StoredRequestState</code> derived from the request's RelayState data.
Return a different StoredRequestState if you would like to customize the
RelayState lookup.
public
System.Func`2
GetPublicOrigin
Notification called when a command is about to construct a fully-qualified url
Return a non-null Uri if you need to override this per request. Otherwise
it will fall back to the normal logic that checks the request Uri
and the SPOptions.PublicOrigin setting
public
System.Func`3
ProcessSingleLogoutResponseStatus
Notification called when single logout status is returned from IDP.
Return true to indicate that your notification has handled this status. Otherwise
it will fall back to the normal status processing logic.
public
System.Func`2
GetBinding
Get a binding that can unbind data from the supplied request. The
default is to use <see cref="M:Sustainsys.Saml2.WebSso.Saml2Binding.Get(Sustainsys.Saml2.WebSso.HttpRequestData)" />
public
System.Action`1
MessageUnbound
Notification called when the command has extracted data from
request (by using <see cref="M:Sustainsys.Saml2.WebSso.Saml2Binding.Unbind(Sustainsys.Saml2.WebSso.HttpRequestData,Sustainsys.Saml2.Configuration.IOptions)" /> )
public
System.Action`2
AcsCommandResultCreated
Notification called when the ACS command has produced a
<see cref="T:Sustainsys.Saml2.WebSso.CommandResult" /> , but before anything has been applied
to the outgoing response. Set the <see cref="P:Sustainsys.Saml2.WebSso.CommandResult.HandledResult" />
flag to suppress the library's built in apply functionality to the
outgoing response.
public
System.Action`1
LogoutCommandResultCreated
Notification called when the Logout command has produced a
<see cref="T:Sustainsys.Saml2.WebSso.CommandResult" /> , but before anything has been applied
to the outgoing response. Set the <see cref="P:Sustainsys.Saml2.WebSso.CommandResult.HandledResult" />
flag to suppress the library's built in apply functionality to the
outgoing response.
public
System.Action`3
LogoutRequestCreated
Notification called when a logout request is created to initiate single log
out with an identity provider.
public
System.Action`3
LogoutRequestXmlCreated
Notification called when a logout request has been transformed to an XML node tree.
public
System.Action`4
LogoutResponseCreated
Notification called when a logout request has been received and processed and a Logout Response has been created.
public
System.Action`3
LogoutResponseXmlCreated
public
System.Action`2
MetadataCreated
Notification called when metadata has been created, but before
signing. At this point the contents of the metadata can be
altered before presented.
public
System.Action`1
MetadataCommandResultCreated
Notification called when the Metadata command has produced a
<see cref="T:Sustainsys.Saml2.WebSso.CommandResult" /> , but before anything has been applied
to the outgoing response. Set the <see cref="P:Sustainsys.Saml2.WebSso.CommandResult.HandledResult" />
flag to suppress the library's built in apply functionality to the
outgoing response.
public
System.Func`2
ValidateAbsoluteReturnUrl
Notification called by the SignIn and Logout commands to validate a ReturnUrl that is not relative.
Return true to indicate that you accept the ReturnUrl, false otherwise.
Default validation do not accept any absolute URL.
When false is returned, the SignIn and Logout commands will throw an <see cref="T:System.InvalidOperationException" /> .
public
System.Func`4
GetIdentityProvider
Notification called when getting an identity provider. Default version is to return
the given idp from Options.IdentityProviders.
public
UnsafeNotifications
Unsafe
Callbacks that allow modifying the validation behavior in potentially unsafe/insecure ways
Methods
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object