shibboleth-3.0.4

shibsp Namespace Reference

Shibboleth Service Provider Library. More...

Classes

class  AbstractSPRequest
 Abstract base for SPRequest implementations. More...
class  AccessControl
 Interface to an access control plugin. More...
class  Application
 Interface to a Shibboleth Application instance. More...
class  Attribute
 A resolved attribute. More...
class  AttributeDecoder
 Decodes XML objects into resolved Attributes. More...
class  BinaryAttribute
 An Attribute whose values are binary data. More...
class  ExtensibleAttribute
 An Attribute whose values are arbitrary structures. More...
class  AttributeFilter
 Engine for filtering attribute values. More...
class  BasicFilteringContext
 A trivial FilteringContext implementation. More...
class  FilteringContext
 Context for attribute filtering operations. More...
class  FilterPolicyContext
 Context for lookup of instantiated MatchFunctor objects. More...
class  MatchFunctor
 A function that evaluates whether an expressed criteria is met by the current filter context. More...
class  NameIDAttribute
 An Attribute whose values are derived from or mappable to a SAML NameID. More...
class  AttributeExtractor
 A service that extracts and decodes attributes from XML objects. More...
class  AttributeResolver
 The service that resolves the attributes for a particular subject. More...
class  ResolutionContext
 A context for a resolution request. More...
class  ScopedAttribute
 An Attribute whose values are relations of a value and a scope. More...
class  SimpleAttribute
 An Attribute whose values are simple strings. More...
class  XMLAttribute
 An Attribute whose values are serialized XML. More...
class  ArtifactResolver
 SAML artifact resolver for SP use. More...
class  ProtocolProvider
 Interface to protocol, binding, and default endpoint information. More...
class  SOAPClient
 Specialized SOAPClient for SP environment. More...
class  AbstractHandler
 Base class for handlers based on a DOMPropertySet. More...
class  AssertionConsumerService
 Base class for handlers that create sessions by consuming SSO protocol responses. More...
class  Handler
 Pluggable runtime functionality that implement protocols and services. More...
class  LogoutHandler
 Base class for logout-related handlers. More...
class  LogoutInitiator
 Pluggable runtime functionality that handles initiating logout. More...
class  RemotedHandler
 Base class for handlers that need HTTP request/response layer to be remoted. More...
class  SecuredHandler
 Pluggable runtime functionality that is protected by simple access control. More...
class  SessionInitiator
 Pluggable runtime functionality that handles initiating sessions. More...
class  SSCache
class  StoredSession
class  XMLApplication
class  XMLConfigImpl
class  XMLConfig
struct  MetadataProviderCriteria
 Extended criteria for metadata lookup for Shibboleth-aware metadata providers. More...
class  DDF
 DDF objects are implemented with a handle-body idiom and require explicit destruction in order to allow stack objects to be freely mixed in structures with heap objects. More...
class  DDFJanitor
 A "smart pointer" for disposing of DDF objects when they leave scope. More...
class  SocketListener
 Berkeley Socket-based ListenerService implementation. More...
class  Remoted
 Interface to a remoted service. More...
class  ListenerService
 Interface to a remoting engine. More...
class  RequestMapper
 Interface to a request mapping plugin. More...
class  SecurityPolicy
 SP-specific SecurityPolicy subclass. More...
class  SecurityPolicyProvider
 Interface to a source of security policy settings and rules. More...
class  ServiceProvider
 Interface to a Shibboleth ServiceProvider instance. More...
class  Session
 Encapsulates access to a user's security session. More...
class  SessionCache
 Creates and manages user sessions. More...
class  SPConfig
 Singleton object that manages library startup/shutdown. More...
class  SPRequest
 Interface to server request being processed. More...
class  TransactionLog
 Interface to a synchronized event/audit logging object. More...
class  LoginEvent
class  LogoutEvent
class  AuthnRequestEvent
class  CGIParser
 CGI GET/POST parameter parsing. More...
class  DOMPropertySet
 DOM-based property set implementation. More...
class  IPRange
 Represents a range of IP addresses. More...
class  PropertySet
 Interface to a generic set of typed properties or a DOM container of additional data. More...
class  TemplateParameters
 Supplies xmltooling TemplateEngine with additional parameters. More...

Functions

void SHIBSP_API registerAccessControls ()
 Registers AccessControl classes into the runtime.
void registerAttributeFactories ()
 Registers built-in Attribute types into the runtime.
void registerAttributeDecoders ()
 Registers built-in AttributeDecoders into the runtime.
void SHIBSP_API registerAttributeFilters ()
 Registers AttributeFilter classes into the runtime.
void SHIBSP_API registerMatchFunctors ()
 Registers MatchFunctor classes into the runtime.
void SHIBSP_API registerAttributeExtractors ()
 Registers AttributeExtractor classes into the runtime.
void SHIBSP_API registerAttributeResolvers ()
 Registers AttributeResolver classes into the runtime.
void SHIBSP_API registerProtocolProviders ()
 Registers ProtocolProvider classes into the runtime.
 DECL_XMLTOOLING_EXCEPTION (AttributeException, SHIBSP_EXCEPTIONAPI(SHIBSP_API), shibsp, xmltooling::XMLToolingException, Exceptions during attribute processing.)
 DECL_XMLTOOLING_EXCEPTION (AttributeExtractionException, SHIBSP_EXCEPTIONAPI(SHIBSP_API), shibsp, shibsp::AttributeException, Exceptions during attribute extraction.)
 DECL_XMLTOOLING_EXCEPTION (AttributeFilteringException, SHIBSP_EXCEPTIONAPI(SHIBSP_API), shibsp, shibsp::AttributeException, Exceptions during attribute filtering.)
 DECL_XMLTOOLING_EXCEPTION (AttributeResolutionException, SHIBSP_EXCEPTIONAPI(SHIBSP_API), shibsp, shibsp::AttributeException, Exceptions during attribute resolution.)
 DECL_XMLTOOLING_EXCEPTION (ConfigurationException, SHIBSP_EXCEPTIONAPI(SHIBSP_API), shibsp, xmltooling::XMLToolingException, Exceptions during configuration.)
 DECL_XMLTOOLING_EXCEPTION (ListenerException, SHIBSP_EXCEPTIONAPI(SHIBSP_API), shibsp, xmltooling::XMLToolingException, Exceptions during inter-process communication.)
void SHIBSP_API registerHandlers ()
 Registers Handler implementations.
void SHIBSP_API registerLogoutInitiators ()
 Registers LogoutInitiator implementations.
void SHIBSP_API registerSessionInitiators ()
 Registers SessionInitiator implementations.
 BEGIN_XMLOBJECT (SHIBSP_API, Scope, xmltooling::XMLObject, Scope element)
 DECL_BOOLEAN_ATTRIB (Regexp, REGEXP, false)
 DECL_SIMPLE_CONTENT (Value)
 BEGIN_XMLOBJECT (SHIBSP_API, KeyAuthority, xmltooling::AttributeExtensibleXMLObject, KeyAuthority element)
 DECL_INTEGER_ATTRIB (VerifyDepth, VERIFYDEPTH)
 DECL_TYPED_FOREIGN_CHILDREN (KeyInfo, xmlsignature)
 DECL_XMLOBJECTBUILDER (SHIBSP_API, Scope, shibspconstants::SHIBMD_NS, shibspconstants::SHIBMD_PREFIX)
 DECL_XMLOBJECTBUILDER (SHIBSP_API, KeyAuthority, shibspconstants::SHIBMD_NS, shibspconstants::SHIBMD_PREFIX)
void SHIBSP_API registerMetadataExtClasses ()
 Registers builders and validators for Shibboleth metadata extension classes into the runtime.
SHIBSP_API std::ostream & operator<< (std::ostream &os, const DDF &obj)
 Serializes a DDF object to a stream.
SHIBSP_API std::istream & operator>> (std::istream &is, DDF &obj)
 Reconstitutes a DDF object from a stream.
void SHIBSP_API registerListenerServices ()
 Registers ListenerService classes into the runtime.
void registerRequestMappers ()
 Registers RequestMapper classes into the runtime.
void SHIBSP_API registerPKIXTrustEngine ()
 Registers trust engine plugin.
void SHIBSP_API registerSecurityPolicyProviders ()
 Registers SecurityPolicyProvider classes into the runtime.
void SHIBSP_API registerServiceProviders ()
 Registers ServiceProvider classes into the runtime.
void SHIBSP_API registerSessionCaches ()
 Registers SessionCache classes into the runtime.
void SHIBSP_API registerEvents ()
 Registers Event classes into the runtime.

Variables

class SHIBSP_API Session
class SHIBSP_API SPRequest
class SHIBSP_API AttributeExtractor
class SHIBSP_API AttributeFilter
class SHIBSP_API AttributeResolver
class SHIBSP_API Attribute
class SHIBSP_API Handler
class SHIBSP_API ServiceProvider
class SHIBSP_API SessionInitiator
SHIBSP_API xmltooling::QName StringAttributeDecoderType
 Decodes into a SimpleAttribute.
SHIBSP_API xmltooling::QName ScopedAttributeDecoderType
 Decodes scoped and NameID attributes into a ScopedAttribute.
SHIBSP_API xmltooling::QName NameIDAttributeDecoderType
 Decodes NameID information into a NameIDAttribute.
SHIBSP_API xmltooling::QName NameIDFromScopedAttributeDecoderType
 Decodes scoped attributes into a NameIDAttribute.
SHIBSP_API xmltooling::QName KeyInfoAttributeDecoderType
 Decodes KeyInfo information into a SimpleAttribute.
SHIBSP_API xmltooling::QName DOMAttributeDecoderType
 Decodes arbitrary DOM information into an ExtensibleAttribute.
SHIBSP_API xmltooling::QName XMLAttributeDecoderType
 Decodes arbitrary XML into an XMLAttribute.
SHIBSP_API xmltooling::QName Base64AttributeDecoderType
 Decodes base64-encoded data into a SimpleAttribute.
class SHIBSP_API FilteringContext
class SHIBSP_API Application
class SHIBSP_API MatchFunctor
SHIBSP_API xmltooling::QName AnyMatchFunctorType
 Always evaluates to true.
SHIBSP_API xmltooling::QName AndMatchFunctorType
 Conjunction MatchFunctor.
SHIBSP_API xmltooling::QName OrMatchFunctorType
 Disjunction MatchFunctor.
SHIBSP_API xmltooling::QName NotMatchFunctorType
 Negating MatchFunctor.
SHIBSP_API xmltooling::QName AttributeIssuerStringType
 Matches the issuing entity's name.
SHIBSP_API xmltooling::QName AttributeRequesterStringType
 Matches the requesting entity's name.
SHIBSP_API xmltooling::QName AuthenticationMethodStringType
 Matches the principal's authentication method/class or context reference.
SHIBSP_API xmltooling::QName AttributeValueStringType
 Matches an attribute's string value.
SHIBSP_API xmltooling::QName AttributeScopeStringType
 Matches an attribute's "scope".
SHIBSP_API xmltooling::QName AttributeIssuerRegexType
 Matches the issuing entity's name.
SHIBSP_API xmltooling::QName AttributeRequesterRegexType
 Matches the requesting entity's name.
SHIBSP_API xmltooling::QName AuthenticationMethodRegexType
 Matches the principal's authentication method/class or context reference.
SHIBSP_API xmltooling::QName AttributeValueRegexType
 Matches an attribute's string value.
SHIBSP_API xmltooling::QName AttributeScopeRegexType
 Matches an attribute's "scope".
SHIBSP_API xmltooling::QName NumberOfAttributeValuesType
 Matches based on the number of values.
SHIBSP_API xmltooling::QName AttributeIssuerInEntityGroupType
 Matches based on metadata groups of issuer.
SHIBSP_API xmltooling::QName AttributeRequesterInEntityGroupType
 Matches based on metadata groups of requester.
SHIBSP_API xmltooling::QName InEntityGroupType
 Matches based on metadata groups of requester.
SHIBSP_API xmltooling::QName AttributeIssuerEntityAttributeExactMatchType
 Matches based on entity attributes of issuer.
SHIBSP_API xmltooling::QName AttributeRequesterEntityAttributeExactMatchType
 Matches based on entity attributes of requester.
SHIBSP_API xmltooling::QName EntityAttributeExactMatchType
 Matches based on entity attributes of requester.
SHIBSP_API xmltooling::QName AttributeIssuerEntityAttributeRegexMatchType
 Matches based on entity attributes of issuer and a regex.
SHIBSP_API xmltooling::QName AttributeRequesterEntityAttributeRegexMatchType
 Matches based on entity attributes of requester and a regex.
SHIBSP_API xmltooling::QName EntityAttributeRegexMatchType
 Matches based on entity attributes of requester and a regex.
SHIBSP_API xmltooling::QName AttributeIssuerEntityMatcherType
 Matches based on issuer and pluggable criteria.
SHIBSP_API xmltooling::QName AttributeRequesterEntityMatcherType
 Matches based on requester and pluggable criteria.
SHIBSP_API xmltooling::QName AttributeScopeMatchesShibMDScopeType
 Matches scope based on metadata Scope extensions.
SHIBSP_API xmltooling::QName AttributeValueMatchesShibMDScopeType
 Matches value based on metadata Scope extensions.
SHIBSP_API xmltooling::QName NameIDQualifierStringType
 Matches based on NameID NameQualifiers.
SHIBSP_API xmltooling::QName AttributeIssuerRegistrationAuthorityType
 Matches based on RegistrationAuthority extension in issuer's metadata.
SHIBSP_API xmltooling::QName RegistrationAuthorityType
 Matches based on RegistrationAuthority extension in requester's metadata.
class SHIBSP_API ResolutionContext
class SHIBSP_API PropertySet
class SHIBSP_API SecurityPolicy
class SHIBSP_API LoginEvent
class SHIBSP_API LogoutEvent
class SHIBSP_API AuthnRequestEvent
class SHIBSP_DLLLOCAL XMLConfig
 END_XMLOBJECT
class SHIBSP_API ListenerService
class SHIBSP_API Remoted
class SHIBSP_API RequestMapper
class SHIBSP_API SessionCache
class SHIBSP_API TemplateParameters
class SHIBSP_API SecurityPolicyProvider
class SHIBSP_API TransactionLog
class SHIBSP_API AccessControl
class SHIBSP_API ProtocolProvider
class SHIBSP_API AttributeDecoder
class SHIBSP_API FilterPolicyContext

Detailed Description

Shibboleth Service Provider Library.


Function Documentation

SHIBSP_API std::ostream& shibsp::operator<< ( std::ostream &  os,
const DDF &  obj 
)

Serializes a DDF object to a stream.

Parameters:
osoutput stream
objDDF object to serialize
Returns:
reference to the output stream
SHIBSP_API std::istream& shibsp::operator>> ( std::istream &  is,
DDF &  obj 
)

Reconstitutes a DDF object from a stream.

Parameters:
isinput stream
objDDF object to reconstitute
Returns:
reference to the input stream
void shibsp::registerAttributeDecoders ( )

Registers built-in AttributeDecoders into the runtime.

void shibsp::registerAttributeFactories ( )

Registers built-in Attribute types into the runtime.

void SHIBSP_API shibsp::registerHandlers ( )

Registers Handler implementations.

void SHIBSP_API shibsp::registerLogoutInitiators ( )

Registers LogoutInitiator implementations.

void SHIBSP_API shibsp::registerSessionInitiators ( )

Registers SessionInitiator implementations.


Variable Documentation

SHIBSP_API xmltooling::QName shibsp::AndMatchFunctorType

Conjunction MatchFunctor.

SHIBSP_API xmltooling::QName shibsp::AnyMatchFunctorType

Always evaluates to true.

Matches based on entity attributes of issuer.

Matches based on entity attributes of issuer and a regex.

SHIBSP_API xmltooling::QName shibsp::AttributeIssuerEntityMatcherType

Matches based on issuer and pluggable criteria.

SHIBSP_API xmltooling::QName shibsp::AttributeIssuerInEntityGroupType

Matches based on metadata groups of issuer.

SHIBSP_API xmltooling::QName shibsp::AttributeIssuerRegexType

Matches the issuing entity's name.

Matches based on RegistrationAuthority extension in issuer's metadata.

SHIBSP_API xmltooling::QName shibsp::AttributeIssuerStringType

Matches the issuing entity's name.

Matches based on entity attributes of requester.

Matches based on entity attributes of requester and a regex.

SHIBSP_API xmltooling::QName shibsp::AttributeRequesterEntityMatcherType

Matches based on requester and pluggable criteria.

SHIBSP_API xmltooling::QName shibsp::AttributeRequesterInEntityGroupType

Matches based on metadata groups of requester.

SHIBSP_API xmltooling::QName shibsp::AttributeRequesterRegexType

Matches the requesting entity's name.

SHIBSP_API xmltooling::QName shibsp::AttributeRequesterStringType

Matches the requesting entity's name.

SHIBSP_API xmltooling::QName shibsp::AttributeScopeMatchesShibMDScopeType

Matches scope based on metadata Scope extensions.

SHIBSP_API xmltooling::QName shibsp::AttributeScopeRegexType

Matches an attribute's "scope".

SHIBSP_API xmltooling::QName shibsp::AttributeScopeStringType

Matches an attribute's "scope".

SHIBSP_API xmltooling::QName shibsp::AttributeValueMatchesShibMDScopeType

Matches value based on metadata Scope extensions.

SHIBSP_API xmltooling::QName shibsp::AttributeValueRegexType

Matches an attribute's string value.

SHIBSP_API xmltooling::QName shibsp::AttributeValueStringType

Matches an attribute's string value.

SHIBSP_API xmltooling::QName shibsp::AuthenticationMethodRegexType

Matches the principal's authentication method/class or context reference.

SHIBSP_API xmltooling::QName shibsp::AuthenticationMethodStringType

Matches the principal's authentication method/class or context reference.

SHIBSP_API xmltooling::QName shibsp::Base64AttributeDecoderType

Decodes base64-encoded data into a SimpleAttribute.

SHIBSP_API xmltooling::QName shibsp::DOMAttributeDecoderType

Decodes arbitrary DOM information into an ExtensibleAttribute.

SHIBSP_API xmltooling::QName shibsp::EntityAttributeExactMatchType

Matches based on entity attributes of requester.

SHIBSP_API xmltooling::QName shibsp::EntityAttributeRegexMatchType

Matches based on entity attributes of requester and a regex.

SHIBSP_API xmltooling::QName shibsp::InEntityGroupType

Matches based on metadata groups of requester.

SHIBSP_API xmltooling::QName shibsp::KeyInfoAttributeDecoderType

Decodes KeyInfo information into a SimpleAttribute.

SHIBSP_API xmltooling::QName shibsp::NameIDAttributeDecoderType

Decodes NameID information into a NameIDAttribute.

SHIBSP_API xmltooling::QName shibsp::NameIDFromScopedAttributeDecoderType

Decodes scoped attributes into a NameIDAttribute.

SHIBSP_API xmltooling::QName shibsp::NameIDQualifierStringType

Matches based on NameID NameQualifiers.

SHIBSP_API xmltooling::QName shibsp::NotMatchFunctorType

Negating MatchFunctor.

SHIBSP_API xmltooling::QName shibsp::NumberOfAttributeValuesType

Matches based on the number of values.

SHIBSP_API xmltooling::QName shibsp::OrMatchFunctorType

Disjunction MatchFunctor.

SHIBSP_API xmltooling::QName shibsp::RegistrationAuthorityType

Matches based on RegistrationAuthority extension in requester's metadata.

SHIBSP_API xmltooling::QName shibsp::ScopedAttributeDecoderType

Decodes scoped and NameID attributes into a ScopedAttribute.

SHIBSP_API xmltooling::QName shibsp::StringAttributeDecoderType

Decodes into a SimpleAttribute.

SHIBSP_API xmltooling::QName shibsp::XMLAttributeDecoderType

Decodes arbitrary XML into an XMLAttribute.