Metadata Requirements

The requirements for service provider metadata for integrating with the Enterprise AuthenticationAuthentication Authentication is the act of determining that a person is who they claim to be. For more information, see our Concepts page. Service are below. The requirements provide a number of critical benefits including greatly reducing the time needed to configure the integration and allows service providers to be the owners of their own contact information.

#TitleUser StoryImportanceNotes
1Metadata has encryption certificateThis enables SAMLSAML Security Assertion Markup Language (SAML) is a standard, XML-based language for exchanging authentication and authorization data between identity providers and service providers. This standard is currently used by Enterprise Authentication (as well as hundreds of service providers that integrate with our identity provider). assertions to be encrypted within the SAML response.Must have1.See SP Signing and Back-Channel TLS Keys and Certificates .
2Metadata has signing certificateThis ensures that communicating entities can verify each other’s identity programmatically.Must have1.See SP Encryption Key and Certificate .
3Metadata passes schema validationThis ensures metadata interoperability as we process it and enables future extensibility for other metadata-managing services we may employ.Must haveCustomer metadata must be schema-valid according to https://docs.oasis-open.org/security/saml/v2.0/saml-schema-metadata-2.0.xsd.

One way to validate is to use the XMLSecTool .
4Metadata is signedProvides additional security around the metadata source.Nice to haveSee Signature Verification .
5Contacts and OrganizationThese contacts will be our source of contact information. This is how we will contact service owners regarding their SSOSSO Single Sign-On (SSO) is a service which allows a user to use one set of credentials to access multiple applications. integration with Enterprise Authentication.Must haveSee Contacts and Organizations .
6Service Provider is part of a federation that we consumeThis reduces the overhead of managing metadata. It also guarantees compliance with above requirements.Nice to haveSee https://www.incommon.org/federation/
7Metadata requests attributesThis supports metadata-driven configurationFuture enhancement
8Metadata publicly accessibleThis ensures that the IdPIdP An Identity Provider (IdP) is a software tool or service that offers user authentication as a service. The IdP manages the user's primary authentication credentials and issues assertions derived from those credentials. At UT Austin, the primary IdP used to authenticate the UT EID and EID Password is Enterprise Authentication, which is managed by the IAM Team. For more information, see our Concepts page. is able to retrieve the SPSP A Service Provider (SP) is the server/system which hosts the resource. In this context, you (or your vendor) are configuring the SP that provides a service to your customers. Your SP will integrate with our IdP. For more information, see our Concepts page.’s metadataMust have3

Metadata correctness guidelines and examples can be found at https://shibboleth.atlassian.net/wiki/spaces/CONCEPT/pages/928645443/MetadataCorrectness .

An example of correct SAML Service Provider metadata can be found below:

Footnotes

  1. Some SAML SPsSP A Service Provider (SP) is the server/system which hosts the resource. In this context, you (or your vendor) are configuring the SP that provides a service to your customers. Your SP will integrate with our IdP. For more information, see our Concepts page. use the same certificates for signing and encryption. This is not uncommon and allowable in the SAML specification. Of those SPs, some combine both certificates into the same element in their metadata. This is also valid per the specification and does meet the Customer Metadata Requirements. Please refer to Encryption KeyDescriptor Type for more information. ↩︎
  2. Some SAML SPs use the same certificates for signing and encryption. This is not uncommon and allowable in the SAML specification. Of those SPs, some combine both certificates into the same element in their metadata. This is also valid per the specification and does meet the Customer Metadata Requirements. Please refer to Encryption KeyDescriptor Type for more information. ↩︎
  3. The SP metadata contains instructions for how the IdP should interact with the SP. If the IdP cannot retrieve the SP’s metadata then it will be unable to communicate with the SP. Due to our IdP’s disaster recovery and business continuity strategies, we strongly recommend against placing the metadata file behind authorizationAuthorization Authorization refers to the act of determining whether an authenticated user is allowed to access a specific resource or take a specific action. For more information, see our Concepts page. or firewall rules; requests may come from on-campus or various cloud-based infrastructure, as needed. ↩︎

Go back to the Vendor Guide to IAM at UT.