(no commit message)
[devwiki.git] / ConfiguringRHEL.mdwn
1 First we need to install and configure moonshot, its dependencies, and a local RADIUS server for testing<br />
2 In a real deployment, a local RADIUS server is not needed, however it simplifies testing if one is available<br />
3 __gss-server__ and __gss-client__ are standard Kerberos diagnostic tools, which give us a lot of information that is helpful for debugging<br />
4 Again, in a real deployment these are not required, but help with testing
5
6 This guide walks through deploying the client, IdP and SP portions of moonshot - depending on your target, some steps may be inappropriate.
7
8 ## Environment
9 ### LD_LIBRARY_PATH
10 __LD_LIBRARY_PATH__ has to have _/opt/moonshot/lib64/_ and _/usr/lib64/freeradius_ added to it.<br />
11 The best way to do this is create a file at _/etc/profile.d/moonshot.sh_, with the following:
12
13     if \[[ $LD_LIBRARY_PATH != */opt/moonshot/lib64/:/usr/lib64/freeradius/* ]]
14     then
15         export LD_LIBRARY_PATH=/opt/moonshot/lib64/:/usr/lib64/freeradius/:$LD_LIBRARY_PATH
16     fi
17
18 After, either restart your shell session, or:
19
20     source /etc/profile.d/moonshot.sh
21
22 This is required as moonshot currently stores its modified libraries separately to the main system ones to avoid conflicts.  This should not be necessary in the future.
23
24 ### SELinux set to permissive
25 Moonshot has a couple of outstanding issues regarding proper labeling of _SELinux_ contexts, causing it to fail when _SELinux_ is enforcing.  This should be resolved soon - change the setting in _/etc/sysconfig/selinux_, or in _/etc/rc.local_:
26
27     echo 0 > /selinux/enforce
28
29 ### EPEL
30 Moonshot needs __EPEL__ for a few extra libraries (as pulling them from a semi-supported repository is preferable to repackaging).<br />
31 The simplest way to install EPEL is:
32
33     rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-5.noarch.rpm
34     yum install epel-release
35
36 ## Moonshot Packages
37 The RPM's and SRPM's for moonshot are currently hosted at [[http://yum.dev.ja.net]] - this may change (and in fact, is quite likely to change) in the future.  The packages are currently unsigned.<br />
38 Example _/etc/yum.repos.d/moonshot.repo_
39
40     [Moonshot]
41     name=Moonshot
42     baseurl=http://yum.dev.ja.net/RPMS/x86_64/
43     gpgcheck=0
44
45 After setting up the repository definition, we'll set up a composite ORPS/IdP.
46
47 ##Moonshot IdP
48 To install the diagnostic tools (only needed for testing) and the RADIUSd:
49
50     yum install freeradius krb5-moonshot-devel moonshot-gss-eap
51
52 Once FreeRADIUS is installed, a source of identity needs to be enabled - either the roaming network in the case of an ORPS, or AD/LDAP/etc for an IdP.  For now, we'll just use a flat file.  Open _/etc/raddb/users_ and locate the following fragment:
53
54
55     # This is a complete entry for "steve". Note that there is no Fall-Through
56     # entry so that no DEFAULT entry will be used, and the user will NOT
57     # get any attributes in addition to the ones listed here.
58     #
59     #   steve   Cleartext-Password := "testing"
60     #   Service-Type = Framed-User,
61     #   Framed-Protocol = PPP,
62
63 Uncomment the line beginning __steve__.
64
65 __Chargeable-User-Identity__ is the value used to decide what user account to log in the user as on the SSH server.<br />
66 This value would normally be set by your local RADIUS proxy (ORPS) – so in a real deployment, rather than statically logging the user in as __moonshot__ you may decide to use something like __steve-camford.ac.uk__.<br />
67 If anonymity is required, you could use a Perl or Python script to generate something like __user-789-camford.ac.uk__.<br />
68 The exact value does not matter – only that the mappings are consistent, so that the user gets access to the same local account each time.
69 To allow creation of accounts on demand you could use __LDAP__ – when the ORPS sees a successful authentication, it could trigger a script that creates the desired account in an __LDAP__ domain.
70 It is not guaranteed that __Chargeable-User-Identity__ will be used permanently – in the future a specific RADIUS attribute may be created instead.
71
72 To activate CUI insertion, Edit _/etc/raddb/sites-enabled/default_, and find the post-auth section, and add the following:
73
74     update reply {
75         Chargeable-User-Identity = "moonshot"
76     }
77
78 Note in the case of an ORPS you need to unfilter this attribute in _/etc/raddb/attrs_ to prevent this attribute from being stripped on roaming requests.
79
80 A legacy attribute required for SSH at this time is the user name returned by the IdP.  To make this happen, Edit _/etc/raddb/sites-enabled/inner-tunnel_, find the following and uncomment it:
81
82                 #update outer.reply {
83                 #       User-Name = "%{request:User-Name}"
84                 #}
85
86 Finally, set the EAP type in use by moonshot (EAP-TTLS) by editing _/etc/raddb/eap.conf_ 
87
88     default_eap_type = md5
89
90 becomes:
91
92     default_eap_type = ttls
93
94 Other EAP types should be supported (PEAP and MD5 tested).
95  
96 FreeRADIUS now has a very minimal IdP/ORPS configuration, and can be started with:
97
98     service radiusd restart
99
100 If you encounter any issues, you can run radius in debug mode to see what is going on internally.
101
102     service radiusd stop
103     radiusd -X
104
105 When in debug mode, FreeRADIUS acts as an interactive program, so it should be run on a separate console, or under GNU Screen.
106
107 ##Moonshot Proper
108 First we need a minimal _/etc/radsec.conf_
109
110     dictionary = "/etc/raddb/dictionary"
111     
112     realm gss-eap {
113         type = "UDP"
114         timeout = 5
115         retries = 3
116         server {
117             hostname = "127.0.0.1"
118             service = "1812"
119             secret = "testing123"
120         }
121     }
122
123 This tells the moonshot SP where to find a RADIUS server for authentication - in this case, we will use the local server just configured.<br />
124 Moonshot will ultimately use RADSEC for communicating with the radius server – in which case you would use __transport="TCP"__ in _/etc/radsc.conf_<br />
125 Ultimately, the final values depend on the deployment – probably the address, port and secret used by your ORPS.
126
127 ###gss_eap_id
128
129 Next, a file is created in the home directory at _~/.gss\_eap\_id_ – this is the file that moonshot looks in for credentials.
130 The format is very simple – username followed by a password on separate lines.  For now, set it to:
131
132     steve
133     testing
134
135 In a deployment with a GUI, this file is replaced by the Moonshot Identity Selector.  It is conceivable in the future that the Identity Selector GUI will be supplemented with a curses-like UI, or other mechanism allowing console usage.
136
137 ###Shibboleth
138
139 Moonshot uses _libshib_ to parse RADIUS and SAML attributes – SAML assertions can be embedded inside RADIUS responses by the IdP, allowing an ORPS to exercise a very fine-grained authorization policy.
140 In the demo we just use a very simple example – mapping the _Chargeable-User-Identity_ to a local user account, but in a real deployment you could map a SAML attribute to the user account just as easily.
141
142 Delete _/etc/shibboleth/attribute-map.xml_ and replace it with:
143
144     <Attributes xmlns="urn:mace:shibboleth:2.0:attribute-map" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
145         <GSSAPIAttribute name="urn:ietf:params:gss-eap:radius-avp urn:x-radius:89" id="local-login-user"/>
146     </Attributes>
147
148 In this case, 89 corresponds to _Chargeable-User-Identity_, which is mapped to _local-login-user_, which sets the local account that the user will be given access to.
149
150 To load the moonshot extensions, under the root node in _/etc/shibboleth/shibboleth2.xml_, add:
151     <Extensions>
152         <Library path="plugins.so" fatal="true"/>
153     </Extensions>
154
155 Further down the same file, find this line:
156
157     <AttributeExtractor type="XML" validate="true" path="attribute-map.xml"/>
158
159 Directly underneath it, add:
160
161     <AttributeExtractor type="GSSAPI" validate="true" path="attribute-map.xml"/>
162
163 Note that this file is sensitive to the order of statements.
164
165 ###/etc/gss/mech
166
167 This file tells moonshot what encryption options are valid for use with GSS.
168
169     #
170     # Sample mechanism glue configuration for EAP GSS mechanism.
171     #
172     # Any encryption type supported by Kerberos can be defined as the
173     # last element of the OID arc.
174     #
175     eap-aes128          1.3.6.1.4.1.5322.22.1.17        mech_eap.so
176     eap-aes256          1.3.6.1.4.1.5322.22.1.18        mech_eap.so
177
178 ##Testing Functionality
179
180 As mentioned earlier, we will be using the Kerberos test tools to make sure that things are working.<br />
181 To start the _gss-server_, run:
182     /opt/moonshot/sbin/gss-server host@localhost &
183
184 There are two ways to start _gss-client_ – the first specifies an encryption method to use by its OID 1.3.6.1.4.1.5322.22.1.18 (as seen in /etc/gss/mech):
185     /opt/moonshot/bin/gss-client -mech "{1 3 6 1 4 1 5322 22 1 18}" 127.0.0.1 host@localhost bar
186
187
188 The second uses __Simple and Protected GSSAPI Negotiation Mechanism (SPNEGO)__<br />
189 This chooses the "best" mutually-agreeable encryption method for between client and server.  To invoke the client using __SPNEGO__, use:
190     /opt/moonshot/bin/gss-client -spnego 127.0.0.1 host@localhost bar
191
192 ##Sample Output
193
194     Attribute local-login-user Authenticated Complete
195     
196     moonshot
197     
198     6d6f6f6e73686f74
199     
200     UID: 501
201     Accepted connection: "steve"
202     Sending init_sec_context token (size=150)...continue needed...
203     
204     context flag: GSS_C_MUTUAL_FLAG
205     context flag: GSS_C_REPLAY_FLAG
206     context flag: GSS_C_SEQUENCE_FLAG
207     context flag: GSS_C_CONF_FLAG 
208     context flag: GSS_C_INTEG_FLAG 
209     "steve" to "host/moonbuildcentos.dev.ja.net", lifetime -1, flags 13e, locally initiated, open
210     Name type of source name is { 1 2 840 113554 1 2 1 1 }.
211     Mechanism { 1 3 6 1 5 5 2 } supports 4 names
212       0: { 1 2 840 113554 1 2 1 1 }
213       1: { 1 2 840 113554 1 2 1 2 }
214       2: { 1 2 840 113554 1 2 1 3 }
215       3: { 1 2 840 113554 1 2 1 4 }
216     Received message: "testing"
217     Signature verified.
218     NOOP token
219
220 Running _gss-client_ produces a massive amount of output.<br />
221 The important part is at the end – you should see output similar to what is on the previous slide.<br />
222 If you do not see the line:
223     Attribute local-login-user Authenticated Complete
224 Then attribute mapping is not functioning properly, and you need to check your shibboleth configuration.
225
226 ##SSH
227 To install moonshot-enabled SSH:
228
229     yum install openssh-moonshot-clients openssh-moonshot-server
230
231
232 Inside _/etc/ssh/sshd\_config_, and if these values are not set already:<br />
233 Uncomment __UsePrivilegeSeparation__ and set it to __‘no’__
234
235         UsePriviligeSeparation no
236
237 Uncomment __GSSAPIAuthentication__ and set it to __‘yes’__
238
239         GSSAPIAuthentication yes
240
241 Uncomment __GSSAPIKeyExchange__ and set it to __‘yes’__
242
243         GSSAPIKeyExchange yes
244
245 Inside _/etc/ssh/ssh\_config_ and if these values are not set already:<br />
246 Uncomment __GSSAPIAuthentication__ and set it to __‘yes’__
247
248         GSSAPIAuthentication yes
249
250 Uncomment __GSSAPIKeyExchange__ and set it to __‘yes’__
251
252         GSSAPIKeyExchange yes
253
254 ###Running SSH
255
256 Finally, we need to start sshd on a seperate port:
257
258     /opt/moonshot/sbin/sshd –p 2222
259
260 At this time we do not recommend running __openssh-moonshot__ as the systemwide SSH client or server – it should be installed alongside the the standard SSH client and server.<br />
261 Also note, that sshd must be invoked with its full path, i.e. _/opt/moonshot/sbin/sshd._
262
263 Finally, try connecting with the following:
264
265     /opt/moonshot/bin/ssh –p 2222 –l "" 127.0.0.1
266
267 With any luck, magic happens and you are logged in as the user specified in your _Chargeable-User-Identity_!<br />
268 After successfully logging in, don’t forget to type __exit__ to end the SSH session and return to the root shell.<br />
269 Note in the SSH client command, the option __-l ""__ – this signifies that no username is to be sent to the SSH server. 
270
271 ##Remote IdP
272 This is left for an exercise for the user - at this stage it should just be a case of changing _/etc/radsec.conf_ to point at the right RADIUSd