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 args['saml_httpd']:
82 path = os.path.join(SAML2_HTTPDIR, args['hostname'])
83 os.makedirs(path, 0750)
87 url = 'https://' + args['hostname']
88 url_sp = url + args['saml_sp']
89 url_logout = url + args['saml_sp_logout']
90 url_post = url + args['saml_sp_post']
95 c.generate('certificate', args['hostname'])
96 m.set_entity_id(url_sp)
98 m.add_service(SAML2_SERVICE_MAP['logout-redirect'], url_logout)
99 m.add_service(SAML2_SERVICE_MAP['response-post'], url_post, index="0")
100 sp_metafile = os.path.join(path, 'metadata.xml')
101 m.output(sp_metafile)
103 if args['saml_httpd']:
104 idp_metafile = os.path.join(path, 'idp-metadata.xml')
105 with open(idp_metafile, 'w+') as f:
108 saml_protect = 'auth'
110 if args['saml_base'] != args['saml_auth']:
111 saml_protect = 'info'
112 saml_auth = '<Location %s>\n' \
113 ' MellonEnable "auth"\n' \
114 '</Location>\n' % args['saml_auth']
117 if args['saml_auth'] == SAML2_PROTECTED:
118 # default location, enable the default page
121 samlopts = {'saml_base': args['saml_base'],
122 'saml_protect': saml_protect,
123 'saml_sp_key': c.key,
124 'saml_sp_cert': c.cert,
125 'saml_sp_meta': sp_metafile,
126 'saml_idp_meta': idp_metafile,
127 'saml_sp': args['saml_sp'],
128 'saml_auth': saml_auth, sp=psp}
129 files.write_from_template(SAML2_CONFFILE, SAML2_TEMPLATE, samlopts)
131 files.fix_user_dirs(SAML2_HTTPDIR, args['httpd_user'])
133 logger.info('SAML Service Provider configured.')
134 logger.info('You should be able to restart the HTTPD server and' +
135 ' then access it at %s%s' % (url, args['saml_auth']))
137 logger.info('SAML Service Provider configuration ready.')
138 logger.info('Use the certificate, key and metadata.xml files to' +
139 ' configure your Service Provider')
147 def saml2_uninstall():
149 shutil.rmtree(os.path.join(SAML2_HTTPDIR, args['hostname']))
150 except Exception, e: # pylint: disable=broad-except
153 os.remove(SAML2_CONFFILE)
154 except Exception, e: # pylint: disable=broad-except
159 logger.info('Uninstalling Service Provider')
160 #FXIME: ask confirmation
162 logger.info('Uninstalled SAML2 data')
165 def log_exception(e):
166 if 'debug' in args and args['debug']:
175 fc = argparse.ArgumentDefaultsHelpFormatter
176 parser = argparse.ArgumentParser(description='Client Install Options',
178 parser.add_argument('--version',
179 action='version', version='%(prog)s 0.1')
180 parser.add_argument('--hostname', default=socket.getfqdn(),
181 help="Machine's fully qualified host name")
182 parser.add_argument('--admin-user', default='admin',
183 help="Account allowed to create a SP")
184 parser.add_argument('--httpd-user', default='apache',
185 help="Web server account used to read certs")
186 parser.add_argument('--saml', action='store_true', default=False,
187 help="Whether to install a saml2 SP")
188 parser.add_argument('--saml-idp-metadata', default=None,
189 help="A URL pointing at the IDP Metadata (FILE or HTTP)")
190 parser.add_argument('--saml-httpd', action='store_true', default=False,
191 help="Automatically configure httpd")
192 parser.add_argument('--saml-base', default='/',
193 help="Where saml2 authdata is available")
194 parser.add_argument('--saml-auth', default=SAML2_PROTECTED,
195 help="Where saml2 authentication is enforced")
196 parser.add_argument('--saml-sp', default='/saml2',
197 help="Where saml communication happens")
198 parser.add_argument('--saml-sp-logout', default='/saml2/logout',
199 help="Single Logout URL")
200 parser.add_argument('--saml-sp-post', default='/saml2/postResponse',
201 help="Post response URL")
202 parser.add_argument('--debug', action='store_true', default=False,
203 help="Turn on script debugging")
204 parser.add_argument('--uninstall', action='store_true',
205 help="Uninstall the server and all data")
207 args = vars(parser.parse_args())
209 if len(args['hostname'].split('.')) < 2:
210 raise ValueError('Hostname: %s is not a FQDN.')
212 # At least one on this list needs to be specified or we do nothing
218 if not present and not args['uninstall']:
219 raise ValueError('Nothing to install, please select a Service type.')
222 if __name__ == '__main__':
228 if 'uninstall' in args and args['uninstall'] is True:
232 except Exception, e: # pylint: disable=broad-except
234 if 'uninstall' in args and args['uninstall'] is True:
235 print 'Uninstallation aborted.'
237 print 'Installation aborted.'
241 if 'uninstall' in args and args['uninstall'] is True:
242 print 'Uninstallation complete.'
244 print 'Installation complete.'