1. Install the Moonshot IdP

We’re now ready to install the Moonshot software and its required dependencies. Install the software by running the following command:

apt-get install moonshot-noshib moonshot-trust-router freeradius-abfab freeradius-utils

2. Configure the Moonshot IdP

Next, we need to configure the Moonshot IdP.

2.1. Configure FreeRADIUS

realm gss-eap {
	type = "TLS"
	cacertfile = "/etc/freeradius/certs/ca.pem"
	certfile = "/etc/freeradius/certs/client.pem"
	certkeyfile = "/etc/freeradius/certs/client.key"
	disable_hostname_check = yes
	server {
		hostname = "127.0.0.1"
		service = "2083"
		secret = "radsec"
	}
}

2.1.1. Realm

We need to configure your realm in the FreeRADIUS server so that it knows not to send any requests for your own users off to another server.

1. Configure your realm in /etc/freeradius/proxy.conf:
   1. Open the file for editing and find the line realm example.com {

   2. Above this, add the following, where YOUR_REALM should be substituted by your realm (e.g. camford.ac.uk):

      realm YOUR_REALM {
      	# Intentionally left blank
      }

2.1.2. Channel Binding Support

We need to configure your FreeRADIUS server to support channel bindings.

1. Open /etc/freeradius/sites-available/abfab-tls for editing:
   1. Scroll to the client default stanza at the bottom of the file

   2. Edit the stanza to match the below:

      client default {
              ipaddr = 0.0.0.0/0
              proto = tls
              gss_acceptor_realm_name = "your IDP realm here"
              trust_router_coi = ov-apc.moonshot.ja.net
      }

      gss_acceptor_realm_name

      Specify the same RP realm as in the rp_realm option in Section 4.1 below. For simple IdP deployments, this usually matches your IDP Realm. When running a mixed IdP-RP Proxy deployment, follow the advice for an RP Proxy.

      Additionally, you must add a domain wildcard constraint in the Jisc Assent Portal that will match this realm value.

   3. If you have any other client definitions here, for example to distinguish between internal and external clients, also apply the change to them.

2.1.3. EAP Type

1. Set the EAP type in use by moonshot (EAP-TTLS) by editing /etc/freeradius/mods-enabled/eap. Find the first instance of default_eap_type = md5 and change it to TTLS.

   default_eap_type = ttls

2.1.4. User Authentication

FreeRADIUS offers many options on to authenticate users; common ones including using a simple local flat file (useful for initial testing), or for production deployments using a credential store in an SQL database or a connection to LDAP/AD.

For the purposes of initial testing, we will use a simple local flat file, creating a user with username "testuser" and password "testing".

1. Open /etc/freeradius/users for editing and put the following at the top of the file

   testuser	Cleartext-Password := "testing"
   			Reply-Message = "Hello test user. You have authenticated!"

   The formatting of the stanza above is very important. There should be a line break before the Reply-Message.

3. Configure the Trust Router Client

If you are going to connect your Moonshot IdP to a Trust Router network, then the next step involves configuring the Trust Router client software and configuring its connection to a Trust Router.

3.1. Configure TIDS

The IdP also runs the Temporary ID Server (TIDS).

1. Open the /etc/default/trust_router file for editing. If necessary, create it.

   ipaddr="[your server IP]"
   hostname="[your server hostname]"
   gssname="trustrouter@ov-apc.moonshot.ja.net"
   

4. Testing

Now that we have the Moonshot IdP installed and configured, we're now ready to test!

4.1. Testing FreeRADIUS locally

The first test is to check whether FreeRADIUS is working in its most basic manner.

1. In window 1, run (as the freerad user)

   su --shell /bin/bash freerad
   freeradius -fxx -l stdout

2. Check that no errors are output.

3. In window 2, run (as root user)

   radtest testuser@YOURREALM testing localhost 2222 testing123

   This uses the "radtest" utility which is used in the following way - radtest username password servername port shared-secret

4. If this is working correctly you should see something like the following:

   In window 1 - FreeRADIUS server output

   Sending Access-Accept of id 57 from 127.0.0.1 port 1812 to 127.0.0.1 port 33363
        Reply-Message = 'Hello test user. You have authenticated!'
   (1) Finished request 1.
   Waking up in 0.3 seconds.
   Waking up in 4.6 seconds.
   (1) Cleaning up request packet ID 57 with timestamp +94
   Ready to process requests.

   In window 2 - radtest client output

   Sending Access-Request of id 57 from 0.0.0.0 port 33363 to 127.0.0.1 port 1812
        User-Name = 'testuser'
        User-Password = 'testing'
        NAS-IP-Address = 127.0.1.1
        NAS-Port = 2222
        Message-Authenticator = 0x00
   rad_recv: Access-Accept packet from host 127.0.0.1 port 1812, id=57, length=61
        Reply-Message = 'Hello test user. You have authenticated!'

4.2. Testing the Trust Router connection

To test the connection to Trust Router, we need to make sure the Temporary Identity Server (TIDS) software is running, then use the Temporary Identity Client (TIDC) software to simulate a connection to the Trust Router.

4.2.1. Testing using the Temporary Identity Client (TIDC)

1. In window 2, (as the freerad user) run the tidc command:

   su --shell /bin/bash freerad
   tidc tr.moonshot.ja.net [your rp-realm] ov-apc.moonshot.ja.net ov-apc.moonshot.ja.net

   This uses the "tidc" binary which is used in the following way - tidc [hostname-of-trust-router] [rp-realm] [hostname-of-apc-server] [apc-name]

2. If the Trust Router connection was successful, you should see something like the following:

   In window 2 - TIDC output

   TIDC Client:
   Server = tr.moonshot.ja.net, rp_realm = moonshot-idp.camford.ac.uk, target_realm = ov-apc.moonshot.ja.net, community = ov-apc.moonshot.ja.net
   connecting to host 'tr.moonshot.ja.net' on port 12309
   CTRL-EVENT-EAP-STARTED EAP authentication started
   CTRL-EVENT-EAP-PROPOSED-METHOD vendor=0 method=21
   CTRL-EVENT-EAP-METHOD EAP vendor 0 method 21 (TTLS) selected
   CTRL-EVENT-EAP-PEER-CERT [...]
   CTRL-EVENT-EAP-SUCCESS EAP authentication completed successfully
   tidc_fwd_request: Sending TID request:
   
   [...]
   
   tr_msg_decode_tidresp(): Success! result = success.
   tr_msg_decode_servers(): Number of servers = 1.
   Response received! Realm = ov-apc.moonshot.ja.net, Community = ov-apc.moonshot.ja.net.
   Client Key Generated (len = 256):
   
   [...]

4.2.2. Testing the Temporary Identity Server (TIDS)

1. In window 3 (as the trustrouter user, window 1 should still be still running the FreeRADIUS server and window 2 the TIDC command), run the TIDS software:

   su --shell /bin/bash trustrouter
   tids --ip [your server IP] --hostname [your server hostname] trustrouter@ov-apc.moonshot.ja.net 

   trustrouter@ov-apc.moonshot.ja.net is the identity that the trust router will use when provisioning keys - this makes it easy to spot in your own log files.
   Specifying your server's IP and hostname may seem redundant (and for single server deployments, it is!). You'll need to set the hostname and IP arguments a little differently if you want to enable some more advanced configurations (such as load balancing and key sharing).

   When using Network Address Translation (NAT) or a firewall, you must specify your external IP address.

2. In window 2, (as the freerad user) run the tidc command again, but this time modify it slightly and specifying the realm you defined in Section 3.1.5 above:

   su --shell /bin/bash freerad
   tidc tr.moonshot.ja.net [your rp-realm] [YOUR_REALM] ov-apc.moonshot.ja.net

   This uses the "tidc" binary which is used in the following way - tidc [hostname-of-trust-router] [rp-realm] [identity realm specified in Section 3.1.5] [apc-name]

3. If the Trust Router connection was successful, you should see something like the following:

   In window 2 - TIDC output

   TIDC Client:
   Server = tr.moonshot.ja.net, rp_realm = moonshot-idp.camford.ac.uk, target_realm = camford.ac.uk, community = ov-apc.moonshot.ja.net
   connecting to host 'tr.moonshot.ja.net' on port 12309
   CTRL-EVENT-EAP-STARTED EAP authentication started
   CTRL-EVENT-EAP-PROPOSED-METHOD vendor=0 method=21
   CTRL-EVENT-EAP-METHOD EAP vendor 0 method 21 (TTLS) selected
   CTRL-EVENT-EAP-PEER-CERT [...]
   CTRL-EVENT-EAP-SUCCESS EAP authentication completed successfully
   tidc_fwd_request: Sending TID request:
   
   [...]
   
   tr_msg_decode_tidresp(): Success! result = success.
   tr_msg_decode_servers(): Number of servers = 1.
   Response received! Realm = camford.ac.uk, Community = ov-apc.moonshot.ja.net.
   Client Key Generated (len = 256):
   
   [...]

   Additionally, in window 1, where FreeRADIUS is running, you should see something similar to this:

   In window 1 - FreeRADIUS output

   (9) Found Auth-Type = Accept
   (9) Auth-Type = Accept, accepting the user
   (9) # Executing section post-auth from file /etc/raddb/sites-enabled/abfab-tr-idp
   (9)   post-auth {
   (9)     [exec] = noop
   (9)     policy remove_reply_message_if_eap {
   (9)       if (&reply:EAP-Message && &reply:Reply-Message) {
   (9)       if (&reply:EAP-Message && &reply:Reply-Message)  -> FALSE
   (9)       else {
   (9)         [noop] = noop
   (9)       } # else = noop
   (9)     } # policy remove_reply_message_if_eap = noop
   (9)   } # post-auth = noop
   (9) Sent Access-Accept Id 0 from 0.0.0.0:2083 to 127.0.0.1:56352 length 196
   (9)   Message-Authenticator = 0x856c08f200d29d641e486a1ccc48799a
   (9)   User-Name = 'trustrouter@ov-apc.moonshot.ja.net'
   (9)   MS-MPPE-Recv-Key = 0xac76ebd3df5fd9f11b57ad0fbc57b92175a8c8f7b4f3ae18bc4ccab5184e6158
   (9)   MS-MPPE-Send-Key = 0xb891112bc014a06dbbeb8170d64136d2e0359a0c255d846fb5772f2733205782
   (9)   EAP-Message = 0x03090004
   (9) Finished request
   Closing TLS socket from client port 56352
   (0) >>> TLS 1.0 Alert [length 0002], warning close_notify
   Client has closed connection
   Waking up in 3.7 seconds.
   (0) <done>: Cleaning up request packet ID 0 with timestamp +25

4. With the tests successful, you can now terminate the FreeRADIUS (window 1) and TIDS (window 3) processes.

5. Next Steps

At this point, you now have a Moonshot IdP that is working and registered with a Trust Router. Now for the next steps:

5.1. Automatically start the software

5.1.1. FreeRADIUS

To automatically start FreeRADIUS, issue the following command (as root):

systemctl enable freeradius
systemctl start freeradius

If this is working correctly, you should see FreeRADIUS running as a daemon process.

5.1.2. TIDS

To automatically start TIDS, issue the following command (as root):

systemctl enable tids
systemctl start tids

If this is working correctly, you should see TIDS running as a daemon process.

5.2. Configure a real source of Authentication

Your FreeRADIUS server can currently only authenticate a single user - "testuser". At this point, you will want to connect to Active Directory, LDAP, an SQL database, or some other source of credentials.

See Configuring FreeRADIUS to Use a Local Identity Store for more information and instructions for how to do this.

5.3. Integrate SAML

As currently configured, this Moonshot IdP can only use RADIUS attributes. If you wish to also include SAML assertions, visit the Issue SAML Assertions page to see the options available to you.

5.4. Configure clients

If you are going to also use your Moonshot IdP as a Moonshot RP (i.e., connect services to it that you wish to allow people to authenticate to using Moonshot), then see the Configure the Moonshot RP Proxy to Talk to Applications/Services page.