The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Revised: May 4, 2015
OL-15762-05
![]() |
We prepared this material with specific expectations of you.
|
User authentication features of DMS-Admin help you to:
Note We support your use of one — and only one — IdP server with Cisco DMS 5.4.
Timesaver Go to terms that start with... [ A | C | D | F | I | L | O | P | R | S | U | X ].
Microsoft implementation of LDAP. A central authentication server and user store. Active Directory is the only LDAP implementation that we support in this release.
|
|
A domain-straddling combination of Active Directory trees within an organization that operates multiple Internet domains. Thus, the forest at “Amalgamated Examples, LLC” might straddle all trees across example
.com
, example
.net
, and example
.org
.
Or, to use Cisco as a real-world case-study, one forest could straddle
cisco.com
and
webex.com
, among others.
Note This Cisco DMS release does not support Active Directory forests. |
|
Note This release is more strict than most prior releases in its enforcement of proper LDAP syntax. Now, when you specify the administrator DN, you must use proper syntax, which conforms exactly to LDIF grammar. When you use poor syntax here for the first time while your DMM appliance runs DMS 5.3, we show you, the administrator, this error message: “Invalid username or password.” But if you used and validated poor syntax here before upgrading to Cisco DMS 5.3, we do not repeat the validation process. Therefore — even though we do not show an error message to anyone — LDAP users simply cannot log in . Note An LDAP expression must never include a space immediately to either side of a “=” sign. Similarly, it must never include a space immediately to either side of an “objectClass” attribute. Otherwise, validation fails. |
|
The process to verify if a directory service entity has correctly claimed its own identity.
|
certification authority
. Authority that issues and manages security credentials and public keys, which any directory service entity relies upon to encrypt and decrypt messages exchanged with any other directory service entity. As part of a public key infrastructure (PKI), a CA checks with a registration authority (RA) to verify information that certificate requestors provide. After the RA verifies requestor information, the CA can then issue a certificate.
|
|
common name
. An attribute-value pair that names one directory service entity but indicates nothing about its context or position in a hierarchy. For example, you might see
cn=administrator
. But
cn=administrator
is so commonplace in theory that it might possibly recur many times in an Active Directory forest, while referring to more than just one directory service entity. An absence of context means that you cannot know which device, site, realm, user group, or other entity type requires the implied “administration” or understand why such “administration” should occur.
Therefore, use of a standalone CN is limited in the LDIF grammar. Absent any context, a standalone CN is only ever useful as an RDN.
Note An LDAP expression must never include a space immediately to either side of a “=” sign. Similarly, it must never include a space immediately to either side of an “objectClass” attribute. Otherwise, validation fails. |
|
domain component
. An attribute to designate one constituent part of a
fully-qualified domain name
(FQDN). Suppose for example that you manage a server whose FQDN is
americas.example.com
. In this case, you would link together three DC attribute-value pairs:
DC=Americas,DC=example,dc=com.
Note An LDAP expression must never include a space immediately to either side of a “=” sign. Similarly, it must never include a space immediately to either side of an “objectClass” attribute. Otherwise, validation fails. |
||
Uniquely encrypted digital representation of one directory service entity, whether physical or logical. This trustworthy representation certifies that the entity is not an imposter when it sends or receives data through a secured channel. The CA normally issues the certificate upon request by the entity or its representative. The requestor is then held accountable as the “certificate holder.” To establish and retain credibility, a certificate must conform to requirements set forth in International Organization for Standardization (ISO) standard X.509. Most commonly, a digital certificate includes the following.
|
||
Any single, named unit at any level within a nested hierarchy of named units, relative to a network. An entity’s essence depends upon its context. This context, in turn, depends upon interactions between at least two service providers — one apiece for the naming service and the directory service — in your network. Theoretically, an entity might represent any tangible thing or logical construct.
|
||
distinguished name
. A sequence of attributes that help a CA to distinguish a particular directory service entity uniquely for authentication. Distinct identity in this case arises from a text string of comma-delimited attribute-value pairs. Each attribute-value pair conveys one informational detail about the entity or its context. The comma-delimited string
is
the actual DN. It consists of the entity’s own CN, followed by at least one OU, and then concludes with at least one DC. For example:
Note An LDAP expression must never include a space immediately to either side of a “=” sign. Similarly, it must never include a space immediately to either side of an “objectClass” attribute. Otherwise, validation fails.
Thus, each DN represents more than merely one isolated element. A DN also associates the element to its specific context within the Active Directory user base that your IdP depends upon.
![]() |
||
identity provider
. One SAML 2.0-compliant server (synchronized to at least one Active Directory user base), that authenticates user session requests upon demand for SPs in one network subdomain. Furthermore, an IdP normalizes data from a variety of directory servers (user stores).
Users send their login credentials to an IdP over HTTPS, so the IdP can authenticate them to whichever SPs they are authorized to use. As an example, consider how an organization could use three IdPs.
![]() Caution Only a well known CA can issue the digital certificate for your IdP. Otherwise, you cannot use SSL, HTTPS, or LDAPS in Federation mode and, thus, all user credentials are passed in the clear.
![]() |
||
Lightweight Directory Access Protocol
. A highly complex data model and communications protocol for user authentication. LDAP provides management and browser applications with access to directories whose data models and access protocols conform to X.500 series (ISO/IEC 9594) standards.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release. |
||
Note Before you try to configure SSL encryption and before you let anyone log in with SSL, you MUST: ![]() |
||
LDAP Data Interchange Format
. A strict grammar that SPs and IdPs use to classify and designate named elements and levels in Active Directory.
|
SAML 2.0-compliant identity and access management server platform written in Java. OpenAM is open source software available under the Common Development and Distribution (CDDL) license. OpenAM is derived from and replaces OpenSSO Enterprise, which also used CDDL licensing. See
http://www.forgerock.com/openam.html
.
|
|
organizational unit
. An LDIF classification type for a logical container within a hierarchical system. In LDIF grammar, the main function of an OU value is to distinguish among superficially identical CNs that might otherwise be conflated. For example:
Note An LDAP expression must never include a space immediately to either side of a “=” sign. Similarly, it must never include a space immediately to either side of an “objectClass” attribute. Otherwise, validation fails. |
SAML 2.0-compliant identity and access management server platform written in Java. PingFederate is proprietary, commercial software. See
http://www.pingidentity.com
.
|
relative distinguished name
. The CN for a directory service entity, as used exclusively (and still without any explicit context) by the one IdP that has synchronized this entity against an Active Directory user base. When an IdP encounters any RDN attribute in an LDIF reference, the IdP expects implicitly that its SAML 2.0-synchronized federation is the only possible context for the CN. It expects this because an IdP cannot authenticate — and logically should never encounter — a directory service entity whose RDN is meaningful to any other federation.
|
A SAML 2.0-compliant architecture for federated identity-based authentication and authorization.
|
|
single sign on
. (And sometimes
“single sign
off
.
”
) The main user-facing benefit of federation mode is that SPs begin — and end, in some implementations — user sessions on behalf of their entire federation. SSO is a convenience for users, who can log in only once per day as their work takes them between multiple servers that are related but independent. Furthermore, SSO is a convenience to IT staff, who spend less time on user support, password fatigue, compliance audits, and so on.
|
Note An LDAP expression must never include a space immediately to either side of a “=” sign. Similarly, it must never include a space immediately to either side of an “objectClass” attribute. Otherwise, validation fails. |
|
Note An LDAP expression must never include a space immediately to either side of a “=” sign. Similarly, it must never include a space immediately to either side of an “objectClass” attribute. Otherwise, validation fails. |
|
A user filter limits the scope of an agreement to import filtered records from an Active Directory user base.
Note An LDAP expression must never include a space immediately to either side of a “=” sign. Similarly, it must never include a space immediately to either side of an “objectClass” attribute. Nor can a group name include any spaces. Otherwise, validation fails. |
A standard for public key infrastructure. X.509 specifies, among other things, standard formats for public key certificates and a certification path validation algorithm. |
Although Cisco DMS always authenticates users, we support three authentication methods.
Note You must choose one of these methods. The method that you use determines which login screen your users will see.
Tip • After a user session times out, we prompt the affected user to log in twice.
FEDERATION (SSO) MODE 1
|
||
---|---|---|
![]() |
![]() |
IdP-specific login screen ![]() |
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
Tip We support IIS 6 on Windows Server 2003.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
When you choose LDAP authentication or SSO authentication, user account data originates from your Active Directory server. However, Cisco DMS does not synchronize (replicate) this data automatically, in real time. Instead, we cache it. Therefore, you must resynchronize user account data when you think it is appropriate to do so. You can:
DMS-Admin synchronizes all user accounts in the Active Directory “user base” that your filter specifies, except users whose accounts are disabled on your Active Directory server.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
We support four types of Active Directory synchronization in LDAP mode or federation mode.
Runs a one-time synchronization for a new filter that you never synchronized previously. |
Runs an incremental, fast update to find and make up for any differences between user accounts that match your Active Directory filter and your local copy of those user accounts. |
Overwrites your local copy of user accounts that correspond to your Active Directory filter with new copies of those user accounts. In addition, deletes your local copy of each user account that has been deleted from Active Directory since the last time that you ran a synchronization. |
Deletes your local copy of user accounts that correspond to a defined Active Directory filter and deletes the entry for that filter from DMS-Admin. |
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
Manual synchronization mode requires you to choose Administration > Settings > Authentication > Synchronize Users > LDAP Bookmarks during all future synchronizations. Afterward, you must click Update.
Manual synchronization mode deletes your schedule for automatic synchronizations.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
Automatic synchronization mode automates and schedules incremental updates to user accounts that match Active Directory filters that you defined in DMS-Admin. When you use automatic synchronization mode, new fields and elements become available to you. These help you to configure the settings for automatic synchronization.
See the “Understand Synchronization of a DMM Group to an LDAP Filter” section .
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
We recommend that you synchronize your LDAP bookmarks periodically. Synchronization ensures that user and group membership associations are current and correct.
The Initial option is CPU-intensive for your DMM appliance and might lower performance temporarily. We recommend that you use it during off-peak hours only. |
|
We recommend that you use the Update option whenever:
|
|
Note The Overwrite option is CPU-intensive for your DMM appliance and might lower its performance temporarily. We recommend that you use this option during off-peak hours only.
|
|
![]() Caution The Delete option is destructive by design. We advise that you use it sparingly and with great caution.
Note Typically, the deletion process takes about 1 minute to finish. However, when there are more than 50,000 users in the Active Directory database, this process might run in the background and take about 30 minutes to finish. In this case, the user interface in DMS-Admin can show that a bookmark was deleted even though the actual process has not finished. If you observe this behavior, simply allow 30 minutes for the operation to finish. |
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
Ordinarily, DMS-Admin will not import any user account record from your Active Directory server when the value in it is blank for any of these attributes:
However, you can import and synchronize all of the Active Directory user account records that match your filters. You can do this even when some of the user account records are incomplete because one or more of their attributes have blank values.
To prevent these undefined attributes from blocking the import of the user accounts they are meant to describe, you can enter generic values for most attributes in the Values to Use by Default column. DMS-Admin takes the generic values that you enter, and then inserts them automatically where they are needed.
Tip Nonetheless, you cannot enter a default value for the Login User Name attribute. Usernames are unique.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
Use “OU” values to impose rough limits on a filter
Use “memberOf” values to pinpoint a filter more precisely
attribute. It stops LDAP from matching records at any lower level than the one you name explicitly. In this scenario for example, you would use
to match only the direct members of the “SanJose” OU.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
After you change a user password on your Active Directory server, there is no requirement to resynchronize the affected user account in DMS-Admin.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
Note Microsoft Active Directory is the only LDAP implementation that we support in this release.
The Authentication page contains four tabbed property sheets.
To use federation (SSO) mode in Cisco DMS, you must have access to an IdP that meets our requirements. Your IdP must meet ALL OF THESE CRITERIA IN COMBINATION:
– Web Browser SSO Profile
– Enhanced Client or Proxy (ECP) Profile
<SingleSignOnService Location=http://idp.example.com/idp/SSO.sml2” Binding=”urn:oasis:names:tc:SAML:2.0:bindings:SOAP”/>
In practice, these requirements limit your IdP to ones that we certify and NO OTHER. We certify OpenAM, PingFederate, and Shibboleth. (CSCua29696)
1. Configure and set up an Active Directory server.
2. Configure and set up a SAML 2.0-compliant IdP.
Note When you use a “fresh install” of Cisco DMS 5.3 (as opposed to an upgrade), your DMM appliance is configured to use embedded authentication mode by default. But when you upgrade a DMM server that was already configured for an earlier Cisco DMS release, it might use either embedded mode or LDAP mode.
3. Obtain a digital certificate from a trusted CA and install it on your IdP.
4. Use DMS-Admin to configure Cisco DMS for federation mode.
5. Export SAML 2.0-compliant metadata from your DMM server and import it into your IdP.
6. Export SAML 2.0-compliant metadata from your IdP and import it into your DMM server.
7. Configure Active Directory exactly as you would in LDAP mode.
8. Click Update to save your work, and then advance to the Synchronize Users property sheet.
9. Synchronize DMM with your Active Directory server to populate the DMM user database.
Note You MUST configure at least one LDAP bookmark.
10. Synchronize users exactly as you would in LDAP mode.
Note Whenever you change any setting or value on your IdP or any of your SPs, you must reestablish their pairing to restore mutual trust among them.
1. A web browser requests access to a protected resource on an SP. Your federation will not approve or deny this request until it knows more. |
|
2. The SP asks its IdP if the browser is currently authenticated to any valid user account in the CoT. |
|
3. The IdP verifies that: |
|
4. The IdP acts on the SP’s behalf and redirects the browser immediately to the protected resource. |
1. A web browser requests access to a protected resource on an SP. Your federation will not approve or deny this request until it knows more. |
|
2. The SP asks its IdP if the browser is currently authenticated to any valid user account in the CoT. |
|
3. The IdP verifies that: |
|
4. The IdP redirects the browser to the SP , where an HTTP 403 Forbidden message states that the user is not authorized to access the protected resource. |
1. A web browser requests access to a protected resource on an SP. Your federation will not approve or deny this request until it knows more. |
|
2. The SP asks its IdP if the browser is currently authenticated to any valid user account in the CoT. |
|
3. The IdP reports that: |
|
4. The SP redirects the browser automatically to an HTTPS login prompt on the IdP, where one of the following occurs.
|
When you migrate from LDAP (via Active Directory) or federation mode to embedded authentication mode, you must explicitly choose whether to keep local copies of the:
Note • Unless you choose explicitly to keep the local copy of a user, a group, or a policy, we discard the local copy.
The result varies according to the combination of your choices.
|
6.This security feature protects your network and user data. If anyone gains unauthorized access to the exported file and tries to use it, Active Directory rejects the invalid passwords. |
Note • Before you migrate from embedded authentication mode to federation mode, you must install a digital certificate from a trusted CA on your IdP server. Otherwise, you cannot migrate to federation mode at all.
Step 1 Open a web browser on your Active Directory server and connect to http://localhost/certsrv .
Step 2 Click Download a CA certificate .
Step 3 Choose the current CA certificate.
The X.509 certificate that you export must be DER-encoded, and it can be binary or printable (Base64). However, when you use Base64, the certificate file must include these lines:
Step 5 Click Download CA certificate .
Step 6 Save this certificate in a file.
For example, you might call the certificate ADcertificate.cer .
Step 7 Stop. You have completed this procedure.
Step 2 Choose Security > Authentication > Select Mode .
Step 4 Check the Use SSL Encryption check box.
Additional user interface elements now appear, which are relevant to SSL and digital certificates.
Step 5 Upload the root CA certificate file that you saved locally.
a. Click Upload , and then click Add .
b. Browse to the file on a local volume.
c. Click the filename and press Enter .
d. Click OK to save your work and dismiss the dialog box.
Step 6 Enter the details for your Active Directory server.
Tip Be sure to use the logical port where your Active Directory server actually listens for SSL connections. The standard port number for LDAPS is 636. However, your Active Directory server might be configured to use some other port.
Step 7 As prompted, use DMS-Admin to restart Web Services (Tomcat).
The installed certificate cannot take effect until after you restart Tomcat.
Step 8 Stop. You have completed this procedure.
Step 2 Choose Security > Authentication .
Step 3 Use elements on the Select Mode property sheet to choose an authentication mode.
Note Migration from one mode to another takes as long as 1 minute to finish (CSCtn22370).
The authentication settings that you changed are now in effect.
Step 5 Stop. You have completed this procedure.
Step 2 Choose Security > Authentication .
a. Use elements on the Define Filter property sheet to define, validate, and add one LDAP filter.
c. Repeat this step for each filter to be added.
The authentication settings that you changed are now in effect.
Step 5 Stop. You have completed this procedure.
Step 2 Choose Security > Authentication > Synchronize Users.
Tip Is the Synchronize Users tab disabled (dimmed), so that you cannot click it? If so, refresh your browser.
Step 3 Find the relevant bookmark among all your saved bookmarks.
Step 4 Choose Initial as the synchronization type.
Note Please wait. Your request might take as long as 1 minute to process (CSCtn22370).
Step 6 Stop. You have completed this procedure.
Step 2 Choose Security > Authentication > Synchronize Users.
Tip Is the Synchronize Users tab disabled (dimmed), so that you cannot click it? If so, refresh your browser.
Step 3 Find the relevant bookmark among all your saved bookmarks.
Step 4 Choose Update as the synchronization type.
Note Please wait. Your request might take as long as 1 minute to process (CSCtn22370).
Step 6 Stop. You have completed this procedure.
Step 2 Choose Security > Authentication > Synchronize Users.
Tip Is the Synchronize Users tab disabled (dimmed), so that you cannot click it? If so, refresh your browser.
Step 4 Delete all relevant filters from DMS-Admin.
Note Please wait. Your request might take as long as 1 minute to process (CSCtn22370).
The authentication settings that you changed are now in effect.
Step 6 Stop. You have completed this procedure.
Step 2 Choose Security > Synchronize Users > Scheduling ,
Step 3 Choose between manual synchronization and automatic synchronization.
Note You will not see any of the elements that the “Elements for Bookmarks” table describes until after you define at least one filter on the Define Filter property sheet.
The authentication settings that you changed are now in effect.
Step 5 Stop. You have completed this procedure.
Step 2 Click Security > Authentication > Manage Attributes .
Tip Is the Manage Attributes tab disabled (dimmed), so that you cannot click it? If so, refresh your browser.
Step 3 Use elements on the Manage Attributes property sheet to:
You must enter a value for each mandatory attribute. You cannot enter a value to use by default for user names, because each user name is unique.
The authentication settings that you changed are now in effect.
Step 5 Stop. You have completed this procedure.
Step 2 Choose Security > Authentication > Synchronize Users > Scheduling .
Step 3 Click the calendar icon (
) to choose the start date for synchronization.
Step 4 Choose the hour and minute when synchronization should begin. Then, choose either AM or PM as the period.
Step 5 From the Repeat Interval list, choose the interval of recurrence:
If so, check the Synchronize users immediately check box.
The authentication settings that you changed are now in effect.
Step 8 Stop. You have completed this procedure.
You can populate a user group with the returned output from a User Base DN query. However, a group of this kind differs in important ways from a group that you populate manually.
Note • Membership of such groups is dynamic — based on shared characteristics among the group of Active Directory users who match your query.
Step 2 Choose Security > Authentication > Define Filter.
Tip Is the Define Filter tab disabled (dimmed), so that you cannot click it? If so, refresh your browser.
Step 3 Use elements on the Define Filter property sheet to define, validate, and add one LDAP filter.
Step 4
Would you like to add users to a group that exists already?
If so, choose that group name from the User Group (in DMM) list.
OR
Would you like to create and populate an entirely new group?
If so, choose
Create a New User Group
from the User Group (in DMM) list. Then, give the new user group a name.
Note Please wait. Your request might take as long as 1 minute to process (CSCtn22370).
Step 7 Stop. You have completed this procedure.
This section includes configuration examples from IdP implementations that have passed internal Cisco tests for interoperability with Cisco DMS.
Note • We provide these rough examples as a courtesy only. We do not endorse any IdP by name, including any whose setup we mention by name in these examples. Likewise, we do not influence the development of any IdP. We do not know when or how its configuration workflows, daily operation, or overall quality might change in the future. For these reasons, we cannot know beforehand when or how the natural course of its ongoing development might invalidate one or more of the examples in this section. Therefore: Obtain all necessary IdP documentation from your IdP vendor, not Cisco.
Configure OpenAM to use a datastore from Active Directory, unless it already does so. |
Note In Federation mode, we use a synchronization process to learn which usernames are valid in your organization. Later and separately, we use an authentication process to verify user-login credentials. And even though we expect most IdPs will source both of these services from a Microsoft Active Directory server, your organization might use some other other LDAP system to authenticate user sessions. When this is the case, you must install and configure an Active Directory server for synchronization use by Cisco DMS. Otherwise, we cannot learn which usernames are valid. In turn, ordinary users cannot log in to Cisco DMS. To prevent this outcome, you must replicate and synchronize a datastore between your new Active Directory server and your existing LDAP server. Afterward, Cisco DMS can synchronize with the Active Directory datastore. a. In OpenAM Web, choose Access Control > Top Level Realm > Data Stores . b. Enter values to define the attributes of your Active Directory DataStore. You might enter values for some of the attributes (like these ones, for example)...
LDAP Server:
... while leaving other attribute values undefined.
Attribute Name Mapping:
Note These are merely examples. c. Click Federation , and then click your IdP server instance — for example, dmsIdp . d. Click Assertion Processing . e. Change the IDP Attribute Map value from UID=uid to UID=sAMAccountName . |
|
Install Enhanced Client or Proxy (ECP), a SAML profile plugin, if you will make API system calls to OpenAM7. |
a. Log in to your Cisco.com user account.
b. Go to
http://cisco.com/cisco/software/release.html?mdfid=280171249&softwareid= c. Use Maven or another method to download release 1.2.14 of the open source logging framework called log4j . d. Copy your downloaded ECP and log4j files to /$OPENSSO_HOME/WEB-INF/lib , . e. Restart your servlet container — for example, tomcat. f. In OpenAM Web, click Federation , and then click your IdP server instance — for example, dmsIdp . h. In the ECP Configuration area, set the IDP Session Mapper value to com.cisco.dms.core.security.aaa.sso.saml2.ecp.idp.plugin.DmsIDPECPSessionMapper . |
|
Export SP metadata from Cisco DMS. |
Export metadata from each SP that will participate in your OpenAM CoT. Tip For Cisco DMS, see the “Export SP Metadata from DMM” topic.
|
|
Import SP metadata from Cisco DMS. |
a. Go to the console page and click Register Remote Service Provider . c. Click Upload , and then navigate to the SP metadata that you exported from DMS-Admin and saved as dms_sp_config.xml . d. Click Configure , and then click Federation . e. Make sure that dmsServiceProvider (SAMLv2 SP Remote) has a defined value. |
|
Make sure that OpenAM is configured to issue the Principal attribute. |
a. In OpenAM Web, click Federation , and then click your IdP server instance — for example, dmsIdp . b. Click Assertion Processing . c. In the Attribute Mapper area, set the Attribute Map value to UID=uid . e. Click the SP entity instance for your DMM appliance. The Assertion Content tab is selected automatically. f. In the Request/Response Signing area, check both of these check boxes: g. Choose Access Control > / (Top Level Realm) > Authentication . i. Make sure that the User Profile value is set to Required . This will cause OpenAM to pass the user IDs of logged-in users to DMM and your other SPs. |
|
See the “Import IdP Metadata into DMM” topic. |
||
wget --no-check-certificate https:// <IdP_serverip> : <service_port> /opensso/saml2/jsp/exportmetadata.jsp -O dms_idp_config.xml |
||
a. Go to http://www.shibboleth.net/downloads/identity-provider/latest/ . b. Download the latest Identity Provider software package, such as shibboleth-identityprovider-2.3.0-bin.zip . c. Extract the downloaded archive, and then make the installer script within it, named install.sh , executable. For example:
$ unzip shibboleth-identityprovider-2.3.0-bin.zip d. Run the script to install Shibboleth.
Respond appropriately to these prompts. Shibboleth is now installed and you have completed its basic configuration. Your new Shibboleth system contains these subfolders.
|
||
Export SP metadata from Cisco DMS. |
Export metadata from each SP that will participate in your Shibboleth CoT. Tip For Cisco DMS, see the “Export SP Metadata from DMM” topic.
|
|
Import SP metadata from Cisco DMS. |
Use SFTP or another method to save imported metadata where Shibboleth will access it: /opt/shibboleth-idp/metadata/ . |
|
Use SSH, remote desktop, VNC, or a direct console connection to log in remotely to the system where you installed Shibboleth. |
||
a. Open /opt/shibboleth-idp/conf/attribute-filter.xml for editing. b. Change the attributeID value (at or near line 24) to uid . |
||
a. Open /opt/shibboleth-idp/conf/attribute-resolver.xml for editing. c. Enter these lines after the Attribute Definitions section heading, at or near line 29.
<resolver:AttributeEncoder xsi:type="enc:SAML2String" name="urn:oid:0.9.2342.19200300.100.1.1" friendlyName="uid" />
<resolver:AttributeEncoder xsi:type="enc:SAML2StringNameID" nameFormat="urn:oasis:names:tc:SAML:2.0:nameid-format:transient" />
e. Enter these lines after the Data Connectors section heading, at or near line 288.
<resolver:DataConnector id="myLDAP" xsi:type="dc:LDAPDirectory" xmlns="urn:mace:shibboleth:2.0:resolver:dc"
|
||
a. Open /opt/shibboleth-idp/conf/login.config for editing. b. Find this string, at or near line 45: |
||
a. Open /opt/shibboleth-idp/conf/replying-party.xml for editing. c. Enter these lines after the Metadata Configuration section heading, at or near line 123. |
||
a. Open /opt/shibboleth-idp/metadata/opt/shibboleth-idp/metadata/Idp-metadata.xml for editing. c. Delete lines 67 through 69. e. Enter this new binding immediately before </IDPSSODescriptor> . f. Append :8443 to the end of every FQDN in this file. g. Save your edited copy of this file to your local system. Be sure to use your Shibboleth hostname in the local filename. For example, you might name this local copy idp-shibboleth.xml . |
||
See the “Import IdP Metadata into DMM” topic. |
||
cp /opt/shibboleth-idp/war/idp.war /usr/local/tomcat/webapps/ |
||
b. Check for the “OK” message at http:// < hostname > :8080/idp/profile/Status . |
||
Export SP metadata from Cisco DMM. |
Export metadata from each SP that will participate in your PingFederate CoT. Tip For Cisco DMS, see the “Export SP Metadata from DMM” topic.
|
|
Import SP metadata into PingFederate. |
a. Log in to PingFederate as its administrator. b. Find the SP Connections area in the My IdP Configuration column and click Create New . c. Click Do not use a template for this connection on the Configuring SP Connection/Connection Template page, and then click Next . d. Check the Browser SSO Profiles check box on the Configuring SP Connection/Connection Type page, choose SAML 2.0 from the Protocols list, and then click Next . e. Check the Browser SSO check box, and then click Next . f. Click Choose File on the Configuring SP Connection/Import Metadata page, and then navigate to the SP metadata that you exported from DMS-Admin as dms_sp_config.xml . |
|
a. Click Configure Browser SSO on the Configuring SP Connection/Browser SSO page. b. Check the SP Initiated SSO check box on the Browser SSO/SAML Profiles page, and then click Next TWO TIMES. c. Click Configure Assertion Creation on the Browser SSO/Assertion Creation page. d. Click Transient on the Assertion Creation/Identity Mapping page, check the Include attributes in addition to the transient identifier check box, and then click Next . e. Set these attribute-value relationships in the Extend the Contract area on the Assertion Creation/Attribute Contract page.
g. Click Map New Adapter Instance on the Assertion Creation/IdP Adapter Mapping page. h. Choose your appropriate authentication type and adapter instance from the next two pages. The username attribute that you need next is probably part of the adapter contract. Therefore: j. Click Use only the Adapter Contract values in the SAML assertion on the IdP Adapter Mapping/Assertion Mapping page, and then click Next . k. On the IdP Adapter Mapping/Attribute Contract Fulfillment page:
– Locate an adapter value, such as subject or userId , that maps to the username. – Set the UID attribute contract value to match the adapter value that you just found. |
||
a. Click Configure Protocol Settings on the Browser SSO/Protocol Settings page. b. Make sure that the default binding value is set to POST on the Protocol Settings/Assertion Consumer Service URL page, delete all other bindings, and then click Next . c. Clear the Artifact check box on the Protocol Settings/Allowable SAML Bindings page, and then click Next . d. Check these check boxes on the Protocol Settings/Signature Policy page, and then click Next .
e. Click None on the Protocol Settings/Encryption Policy page. |
||
a. Click Configure Credentials on the SP Connection/Credentials page. b. Click Configure on the Credentials/Back-Channel Authentication page. c. Check the Use Digital Signatures to guarantee payload in Browser SSO profile check box on the Back-Channel Authentication/Inbound SOAP Authentication Type page, and then click Next . d. Click Done on the Back-Channel Authentication/Summary page. e. Choose the appropriate certificate on the Credentials/Digital Signature Settings page, check the Include the certificate in the signature <KeyInfo> Element check box, and then click Next . f. Click Manage Signature Verification Settings... on the Credentials/Signature Verification Settings page. g. Click Unanchored on the Signature Verification/Trust Model page, and then click Next . h. Choose your DMM certificate (example: dmm.example.com ) from the Primary list on the Signature Verification/Signature Verification Certificate page, and then click Next . Note DO NOT choose any secondary certificate. If the Primary list does not include your DMM certificate, do the following. 1. Click Manage Certificates on the Signature Verification/Signature Verification Certificate page. 2. Click Choose File on the Import Certificate/Import Certificate page, and then navigate to the X509 digital certificate file (*.cer) that you output from DMM. Note Make sure that your certificate file includes the preamble and postscript that are mandatory for PEM-formatted certificates. The preamble and postscript look like this. 3. Click Open , and then click Next THREE TIMES. 4. Check the Make this the active certificate check box on the Import Certificate/Summary page, and then click Done . i. Click Done on the Certificate Management/Manage Digital Verification Certificates page. j. Click Next on the Signature Verification/Signature Verification Certificate page. k. Click Done on the Signature Verification/Summary page. l. Click Next on the Credentials/Signature Verification Settings page. |
||
Set the Connection Status to Active on the SP Connection/Activation & Summary page, and then click Save . |
||
Before you can use Cisco DMS in federation mode, you must export data from DMS-Admin in the form of an SP configuration file. Later, you will import this file into your IdP.
Step 2 Choose Security > Authentication .
Step 3 Check the Federation check box.
Step 5 Save the exported file to your client PC or laptop computer as dms_sp_config.xml .
Note See the technical documentation or tutorials for your IdP to understand how it imports SP configuration files. Alternatively, see the topic for your IdP platform in this chapter’s “IdP Configuration Examples” section.
Step 6 Stop. You have completed this procedure.
Before you can use Cisco DMS in federation mode, you must export data from your IdP in the form of an IdP configuration file. This topic explains how to use the exported file after you generate and save it.
Step 2 Choose Security > Authentication .
Step 3 Click Federation to choose it as your authentication mode.
Step 5 Choose and upload the IdP file ( idp_ <type> .xml ) that you saved previously.
Step 6 Enter the necessary LDAP information to use your Active Directory server.
Step 7 Stop. You have completed this procedure.
Your DMM server features a special login form, which rejects every username except superuser . You use this special form whenever Cisco DMS runs in federation mode or an error has prevented migration from one authentication mode to another.
Step 1 Go to http:// <FQDN> :8080/dmsadmin/admin/login .
a. Enter superuser in the Username field.
b. Enter the corresponding password in the Password field.
Step 2 Stop. You have completed this procedure.
Administration > Security > Authentication > Select Mode
Requires users who log in to DMM to authenticate against a user account database that is native to DMM. This database is independent of every other type of authentication that you might use in your network. |
|
Automatically deletes all user accounts except superuser . Requires future users to authenticate against the user account data from your Active Directory server when they log in to DMM. Microsoft Active Directory is the only LDAP implementation that we support in this release. |
|
Automatically deletes all user accounts except superuser . Requires future users to authenticate themselves to your IdP when they log in to DMM. |
|
This value becomes populated for the first time after you succeed at least once in importing configuration metadata into DMM from your IdP. This element is visible in federation mode only. |
|
Provides the means to import configuration metadata that you previously exported from your IdP and saved to a file. Click Import to browse for the file, which you can then import. This element is visible in federation mode only. |
|
(CSCtn15472) While it names an IdP explicitly, this value does not necessarily identify the IdP in current use. Instead, this value describes only your most recent attempt to import configuration metadata from an IdP, without regard for whether the attempt failed or succeeded. This element is visible only in federation mode. It becomes populated for the first time after you attempt at least once to import IdP metadata. | |
Provides the means to export configuration metadata from DMM. Click Export to begin browsing for a folder on a locally mounted drive where you can save the exported config file. Later, you will import this file into your IdP. This element is visible in federation mode only. | |
Helps you to test whether your federation mode settings are correct and will allow SSO for your ordinary users. Check this check box to expose UI elements that are otherwise hidden. Clear this check box to hide such elements. | |
Enter a username that your IdP already knows. Do not use the “superuser” username. This element is visible only while the Enable Authentication Test check box is checked. | |
Enter the password that corresponds to the test username. This element is visible only while the Enable Authentication Test check box is checked. | |
Enables or disables an anonymous connection between your DMM appliance and your Active Directory server.
In the latter case, your Active Directory server will reject any attempt to log in anonymously. This check box is available to you only when you choose LDAP mode or federation mode. |
|
Enter the routable IP address or DNS-resolvable hostname for the Active Directory server. This field is available to you only when you choose LDAP mode or federation mode. |
|
Enter the TCP port number that your Active Directory server uses for communications. This field is available to you only after you choose LDAP mode or federation mode. The Active Directory port number by default is: |
|
Enter the distinguished name of the Active Directory server administrator. This field is available to you only after you choose LDAP mode or federation mode and uncheck the Anonymous check box. Tip See administrator DN. | |
Enter the password that is associated with the Administrator DN. This field is available to you only after you choose LDAP mode or federation mode and uncheck the Anonymous check box. | |
The check box to enable or disable encrypted sign-on. This check box is available to you only when you use LDAP mode or federation mode. Note Whenever you enable SSL or install a new SSL certificate for LDAP, you must restart Web Services (Tomcat) from AAI. Otherwise, LDAP users cannot log in and the new (or newly enabled) SSL certificate cannot take effect. Also — if your DMM server is one half of a failover pair — the Tomcat restart will trigger immediate failover. (CSCtl09696) Enabling SSL causes the connections between your DMM appliance and your Active Directory server to use LDAPS. An LDAPS connection is suitable when you want to prevent untrusted third parties from reading credentials that the servers exchange. | |
Helps you to upload the digital certificate that your Active Directory server uses for LDAPS communications. This field is available to you only while the Use SSL Encryption check box is checked. | |
Saves and applies your work on the Authentication Mode property sheet. |
|
Discards your work on the Authentication Mode property sheet and resets all values to their previous configuration. |
Administration > Security > Authentication > Define Filter
Administration > Security > Authentication > Synchronize Users
Administration > Security > Authentication > Synchronize Users
Enables one synchronization mode to receive updated user account information from an Active Directory server. We support two such modes but they are mutually exclusive. Whenever you enable one, you disable the other. Click either Manual Synchronization or Automatic Synchronization . |
|
Submits your selections for the type of synchronization and the scope of access that you chose and configured. Synchronization of the specified type starts immediately. |
|
Resets all entries to their previous values on the Scheduling property sheet. |
Administration > Security > Authentication > Manage Attributes
Values that DMS-Admin uses to describe and identify various attributes that it associates with each user account. You cannot change the values in this column. They are for your reference only, to help you enter suitable values (and recognize suitable values when you see them) in the LDAP Attribute Name column and the Values to Use by Default column. |
|
Values that your Active Directory server uses — which correspond one-to-one with values in the DMM Attribute Row column — to describe and identify attributes of each user account. In its factory-default configuration, DMS-Admin prepopulates all fields in this column with the most commonplace values that Active Directory servers use for this purpose. When the values for these attributes differ on your Active Directory server or when you prefer to import objects that use other Active Directory attributes, you can edit the values in this column. |
|
Enter text to insert automatically when the value is blank for the corresponding attribute in an Active Directory user account that you import or synchronize. To ensure that DMS-Admin imports each valid user account that matches a filter, we recommend that you enter values for these attributes: For your convenience, you can also enter values to insert automatically when the values are blank for other attributes — such as Company, Department, or Phone Number — but this is optional. Note You cannot enter a value to use by default as the Login User Name value. |
|
Tells DMM to ignore whether your Active Directory server makes use of the User Account Control Flags attribute. DMM expects to find this attribute on your Active Directory server and, when the attribute is not present, authentication fails. |
|
Returns all values in the LDAP Attribute Name column to the most commonplace values that Active Directory servers use. If you entered different values manually because the labels for these attributes differ on your Active Directory server or because you prefer to import user accounts that use other Active Directory attributes, DMS-Admin deletes what you entered. |
|
Saves and applies your work in the Manage Attributes property sheet. |
LDAP 9 |
||
urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport (Text) |
||
subject10 (Adapter) |
||
https://example.cisco.com:8443/opensso/Consumer/metaAlias/sp (POST) |
||
Use Digital Signatures to guarantee payload in Browser SSO profile |
||
CN=
|
||
CN=
|
Q. Which Active Directory releases does Cisco DMS support?
Our completed tests succeeded as follows.
Windows Active Directory Server 2000
Q. Are there any special APIs to use federation mode ?
No. We support one set of API calls that work identically across all supported authentication modes. See http://developer.cisco.com .
Q. Does DMM perform trust validation of certificates that it imports with IdP metadata?
Q. Do you support any use of certificate revocation lists?
Q. Can I use one browser to connect simultaneously to more than one DMM appliance?
No. Each time that you connect to an additional instance, you are logged out of any prior instance in that browser. However, you can use multiple browsers together for this purpose.
Q. Why would user sessions time out for DMM users after a different interval than I set in DMM?
This can happen when session timeout values differ between your DMM appliance and your IdP. Reconfigure these servers to share one identical session timeout value.
Q. Why does an error message state that an Active Directory password is not valid?
Explanation A “User must change password at next login” flag might be set on your Active Directory server. While this flag is set, the affected user cannot log in to any Cisco DMS component. DMS-Admin cannot change any password on your Active Directory server.
Recommended Action Use features that your Active Directory server provides for this purpose.
Q. Why does an error message state that filter validation has failed?
Explanation Filters fail when they point to empty containers. They also fail in response to filter expressions that includes any spaces.
Recommended Action Make sure on your Active Directory server that your filter did not refer to an empty organizational unit (OU) container. Confirm also that your filter expression does not contain even one space.
Q. Why would my API calls receive an HTTP 401 Unauthorized error?
Recommended Action When you use federation mode, enable ECP on your IdP server.
Q. When I use LDAP authentication with Cisco DMS, which ports must remain open in my network?
Your DMM appliance accepts user authentication requests securely through port 443 . DMM then passes these requests securely to your Active Directory server through port 389 . Also, SSL uses port 636 .
Q. Can I block Cisco DMS access to one particular Active Directory user account, when it is among the matched results for an otherwise useful LDAP filter?
Yes. Extend your query to include a logical NOT (
!
) operator for an attribute whose value is unique to this user. This example uses the LDAP “
samAccountName
” attribute name, which DMM uses by default to populate the corresponding login name for DMM. However, if your Active Directory server uses any other attribute name than “
samAccountName
” for this purpose, you must update the example syntax accordingly when you extend your query.
Tip Information on the Manage Attributes property sheet in DMS-Admin confirms whether your Active Directory server uses the “samAccountName
” attribute name.