3 # Copyright (C) 2014 Simo Sorce <simo@redhat.com>
5 # see file 'COPYING' for use and warranty information
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 from ipsilon.tools.saml2metadata import Metadata
21 from ipsilon.tools.saml2metadata import SAML2_NAMEID_MAP
22 from ipsilon.tools.saml2metadata import SAML2_SERVICE_MAP
23 from ipsilon.tools.certs import Certificate
24 from ipsilon.tools import files
35 HTTPDCONFD = '/etc/httpd/conf.d'
36 SAML2_TEMPLATE = '/usr/share/ipsilon/templates/install/saml2/sp.conf'
37 SAML2_CONFFILE = '/etc/httpd/conf.d/ipsilon-saml.conf'
38 SAML2_HTTPDIR = '/etc/httpd/saml2'
39 SAML2_PROTECTED = '/saml2protected'
41 #Installation arguments
45 logger = logging.getLogger()
49 global logger # pylint: disable=W0603
50 logger = logging.getLogger()
51 lh = logging.StreamHandler(sys.stderr)
56 logger.info('Installing SAML2 Service Provider')
58 if args['saml_idp_metadata'] is None:
59 #TODO: detect via SRV records ?
60 raise ValueError('An IDP metadata file/url is required.')
65 if os.path.exists(args['saml_idp_metadata']):
66 with open(args['saml_idp_metadata']) as f:
68 elif args['saml_idp_metadata'].startswith('file://'):
69 with open(args['saml_idp_metadata'][7:]) as f:
72 r = requests.get(args['saml_idp_metadata'])
75 except Exception, e: # pylint: disable=broad-except
76 logger.error("Failed to retrieve IDP Metadata file!\n" +
77 "Error: [%s]" % repr(e))
81 if not args['saml_no_httpd']:
82 path = os.path.join(SAML2_HTTPDIR, args['hostname'])
83 os.makedirs(path, 0750)
88 if not args['saml_secure_setup']:
90 url = '%s://%s' % (proto, args['hostname'])
91 url_sp = url + args['saml_sp']
92 url_logout = url + args['saml_sp_logout']
93 url_post = url + args['saml_sp_post']
98 c.generate('certificate', args['hostname'])
99 m.set_entity_id(url_sp)
101 m.add_service(SAML2_SERVICE_MAP['logout-redirect'], url_logout)
102 m.add_service(SAML2_SERVICE_MAP['response-post'], url_post, index="0")
103 sp_metafile = os.path.join(path, 'metadata.xml')
104 m.output(sp_metafile)
106 if not args['saml_no_httpd']:
107 idp_metafile = os.path.join(path, 'idp-metadata.xml')
108 with open(idp_metafile, 'w+') as f:
111 saml_protect = 'auth'
113 if args['saml_base'] != args['saml_auth']:
114 saml_protect = 'info'
115 saml_auth = '<Location %s>\n' \
116 ' MellonEnable "auth"\n' \
117 '</Location>\n' % args['saml_auth']
120 if args['saml_auth'] == SAML2_PROTECTED:
121 # default location, enable the default page
125 if args['saml_secure_setup']:
128 samlopts = {'saml_base': args['saml_base'],
129 'saml_protect': saml_protect,
130 'saml_sp_key': c.key,
131 'saml_sp_cert': c.cert,
132 'saml_sp_meta': sp_metafile,
133 'saml_idp_meta': idp_metafile,
134 'saml_sp': args['saml_sp'],
135 'saml_secure_on': saml_secure,
136 'saml_auth': saml_auth,
138 files.write_from_template(SAML2_CONFFILE, SAML2_TEMPLATE, samlopts)
140 files.fix_user_dirs(SAML2_HTTPDIR, args['httpd_user'])
142 logger.info('SAML Service Provider configured.')
143 logger.info('You should be able to restart the HTTPD server and' +
144 ' then access it at %s%s' % (url, args['saml_auth']))
146 logger.info('SAML Service Provider configuration ready.')
147 logger.info('Use the certificate, key and metadata.xml files to' +
148 ' configure your Service Provider')
156 def saml2_uninstall():
158 shutil.rmtree(os.path.join(SAML2_HTTPDIR, args['hostname']))
159 except Exception, e: # pylint: disable=broad-except
162 os.remove(SAML2_CONFFILE)
163 except Exception, e: # pylint: disable=broad-except
168 logger.info('Uninstalling Service Provider')
169 #FXIME: ask confirmation
171 logger.info('Uninstalled SAML2 data')
174 def log_exception(e):
175 if 'debug' in args and args['debug']:
184 fc = argparse.ArgumentDefaultsHelpFormatter
185 parser = argparse.ArgumentParser(description='Client Install Options',
187 parser.add_argument('--version',
188 action='version', version='%(prog)s 0.1')
189 parser.add_argument('--hostname', default=socket.getfqdn(),
190 help="Machine's fully qualified host name")
191 parser.add_argument('--admin-user', default='admin',
192 help="Account allowed to create a SP")
193 parser.add_argument('--httpd-user', default='apache',
194 help="Web server account used to read certs")
195 parser.add_argument('--saml', action='store_true', default=True,
196 help="Whether to install a saml2 SP")
197 parser.add_argument('--saml-idp-metadata', default=None,
198 help="A URL pointing at the IDP Metadata (FILE or HTTP)")
199 parser.add_argument('--saml-no-httpd', action='store_true', default=False,
200 help="Do not configure httpd")
201 parser.add_argument('--saml-base', default='/',
202 help="Where saml2 authdata is available")
203 parser.add_argument('--saml-auth', default=SAML2_PROTECTED,
204 help="Where saml2 authentication is enforced")
205 parser.add_argument('--saml-sp', default='/saml2',
206 help="Where saml communication happens")
207 parser.add_argument('--saml-sp-logout', default='/saml2/logout',
208 help="Single Logout URL")
209 parser.add_argument('--saml-sp-post', default='/saml2/postResponse',
210 help="Post response URL")
211 parser.add_argument('--saml-secure-setup', action='store_true',
212 default=True, help="Turn on all security checks")
213 parser.add_argument('--debug', action='store_true', default=False,
214 help="Turn on script debugging")
215 parser.add_argument('--uninstall', action='store_true',
216 help="Uninstall the server and all data")
218 args = vars(parser.parse_args())
220 if len(args['hostname'].split('.')) < 2:
221 raise ValueError('Hostname: %s is not a FQDN.')
223 # At least one on this list needs to be specified or we do nothing
229 if not present and not args['uninstall']:
230 raise ValueError('Nothing to install, please select a Service type.')
233 if __name__ == '__main__':
239 if 'uninstall' in args and args['uninstall'] is True:
243 except Exception, e: # pylint: disable=broad-except
245 if 'uninstall' in args and args['uninstall'] is True:
246 print 'Uninstallation aborted.'
248 print 'Installation aborted.'
252 if 'uninstall' in args and args['uninstall'] is True:
253 print 'Uninstallation complete.'
255 print 'Installation complete.'