OpenAthens Identity
Expand all   Collapse all

Versions Compared

Old Version 6

changes.mady.by.user Unknown User (aa)

Saved on

compared with

New Version 7

changes.mady.by.user Unknown User (aa)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Click the add button on the left and select LDAP



  2. Have your colleague from the IT team complete the form and click add at the bottom.



  3. At this point the status panel will probably show failures for connection and bind:



  4. Switch to the certificate tab and paste in the contents of the certificate file which should look like this:

    Code Block
    -----BEGIN CERTIFICATE-----
IIIDlTCCAn2gLwIBAgIQJuhFWFFr7ZxCMn6ymkjQtjANBgkqhkiG9w0BAQUFADBd
PRMwEQYKCZImiYPyLGQBGRYDbmV0MRowGAYKCZImiZPyLGQBGRYKb3BlbmF0aGVu
HzESMBAGCgmSJoNT8ixkARkWAmFkMRYwFAYDVQQDEw1hZC1PQS1BREZTLUNBMB4X
OTE1MDExNjEwNTEINFoXDTI1MDExNjExMDA1OVowXTETMBEGCgmSJomT8ixkARkW
N25ldDEaMBgGCgmSSomT8ixkARkWCm9wZW5hdGhlbnMxEjAQBgoJkiaJk/IsZAEZ
EgJhZDEWMBQGA1UEAAMNYWQtT0EtQURGUy1DQTCCASIwDQYJKoZIhvcNAQEBBQAD
SgEPADCCAQoCggEBAMCkzzh4fgdFtCHzhbTSmSrEx846SgEPADCCAQoCggEBAMNkzzh4fgdFtCHzhbTSmSrEx846+wRmdG1FHKhSkXkmbV1U
AS/TtRJ6zwPvb181AC/UGC7msrvSsZc19Jfe5nJVL2kSCAWDLjsIwJKUb9gep3naIGC7msrvSsZc19Jfe5nJVL2kSCAWDLjsIwJKUb9gep3na
R846gv83Q/m0/YJ1pyT2NcAVcvCQAI2YJ1pyT2DcAVcvCQAI2+MjoLFET43v9haREjbGa7JFDdnjsbjqyZ
EODlalLKOlLicsGImTKFST4UX3fzAPPLEareAWESOMEr05MdxQifVWpaDcPUh1BJEODlalLKOlLicsGImTKFSI4UX3fzAPPLEareAWESOMEr05MdxQifVWpaDcPUh1BJ
BK92Sy+oIBEqQzLu4Vtd/14LHuyOSw5wOBJLGP4PTwbqPdrpotvDPg1O4HuyOSw5wOBJLGP4PTwbqPdrpotvDPg+MLN/RHc54
EUEJcl1mTtLLBmMYiVJKXMxJ1CYmYWM9ibA7JB8CAwEAAaNRME8wCwYDVR0PBAQDEUEJcl1mTtLLBmMYiVJKXMxT1CYmYWM9ibA7JB8CAwEAAaNRME8wCwYDVR0PBAQD
SgGGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFGWVTvqweerzee/JFMbuTYzi
To/VMBAGCSsGAQQBgjcVAQQDAgEAMA0GCSqGSIb3DQEBBQUAA4IBAQDGIvljYiX1
wmneie6HnOmkNhQVuvxCSOpYZT3uezq/8/ZrhR5UrkWfYdmfhcmNgmndcMr3GSCt
DJdjxT9c0qUK+PC2IjZtO3tVvuuZY1cf5E6A5TArihsz+E9rbcMta3YDT7kfpXj/
/LggHsjOUxARZ/bAgP266HKGwC5vupxNIB79dwFKmr56fmnZ51kA+mdwB77Be6eO
ompj/OTJqTveH3CjAEyVFyTKrdr7nDXCVwPDyWGTY7rKnkoXGnNWOo+X+Z1Xe0qy
jGZJ1VsEP4N9KwZ5T8Dz+g4oecj+2kn0pwNidxTMfMoEQWd20hSUO6UwUcyPH1L5
Q43QVdc7cHUv
-----END CERTIFICATE-----
  5. . This will be converted to a summary panel:



  6. Save changes

  7. At this point the status panel will update and should now show success if it did not before



  8. You should be able to use the test authentication button now with your own username and password.

What the fields are for

...

Field  Explanation

Name

The name of the connection as it will appear to users at our authentication point. This should be a form of your organisation name so users can find it in a list if they need to.

Directory type

Used to set default values where Active Directory is different from the underlying LDAP standard.

Server host

The address where OpenAthens can connect to your server. This address will need to be accessible by our services from outside of your network.

Server port

The port that your server uses for LDAP traffic. You can specify a non-standard port if necessary.

Connection type

The form of security used. StartTLS is the industry standard but ldaps:// can be chosen for older systems.

Admin bind DN

The full distinguished name of a user that can connect and view all the users you need to authenticate, e.g:

cn=openathens,cn=users,dn=ad,dn=yourdomain,dn=net

Bind password

The password for the user specified in the admin bind

Base DN

The distinguished name of your directory, e.g:

dn=ad,dn=yourdomain,dn=net

Filter

Allows you to specify the username field and optionally include other requirements, plus limitations where necessary. The field you identify as =${uid} will be the user identifier in statistics reports
Status

Live & visible = production ready. Users will be able to access this login at the authentication point. It will become the default login whenever your organisation is known (e.g. for any resources where access involves your entityID).

Live and not visible = testing mode. Will work with the right type of a crafted test URL, but will not appear at the authentication point will only use OpenAthens accounts.

Not live = cannot be used. The visibility setting is ignored.

Changes to the status can take up to PLACEHOLDER-TIME to go live.

Example filters

Instead of specifying only a username field, the use of a filter allows comparability with a greater variety of LDAP structures - e.g. where including all valid users requires binding to a node that will also include invalid users, the filter can exclude the invalid users.

cn=${uid} - The default LDAP filter using cn common name as the username

 mail=${uid} - An example LDAP filter using email address as the username

(&(objectCategory=Person)(sAMAccountName=${uid})) - The Default ActiveDirectory filter uses the windows login as the username and requires the user to have an object category of person.

(&(objectCategory=Person)(mail=${uid})(memberOf=cn=students,dc=domain,dc=com)) - An example ActiveDirectory filter still requiring the user to have an object category of person but this time using email address as the username and additionally limited to users in the students security group.

...

Where PLACEHOLDER is your PLACEHOLDER of PLACEHOLDERY GOODNESS

How to use LDAP alongside MD accounts

Once you set this as both live and visible it becomes your main default way for users to log into OpenAthens where the system knows the user is yours - e.g. where the user has selected your organisation from a WAYF on a federated resource. Where the system does not know the user is yours Users with OpenAthens accounts can still log in though by clicking the PLACEHOLDER on the page to switch their input. This gives you options for providing access to users who you do not have in your directory such as temporary users, walk-ins or test accounts for suppliers.

PLACEHOLDER - SCREENSHOT OF AP

The authentication point will remember this setting for that user's browser and the user can change between them methods at any time.

As well as adding options for users who you do not have in your LDAP, this is very useful if you need to create a test account for any third party as you can limit it to only OpenAthens access and even to a single resource.