1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
#!/usr/bin/python
# Authors:
# Endi S. Dewata <edewata@redhat.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright (C) 2013 Red Hat, Inc.
# All rights reserved.
#
from lxml import etree
import grp
import os
import pwd
import re
import subprocess
import pki
INSTANCE_BASE_DIR = '/var/lib/pki'
REGISTRY_DIR = '/etc/sysconfig/pki'
SUBSYSTEM_TYPES = ['ca', 'kra', 'ocsp', 'tks', 'tps']
class PKIServer(object):
@classmethod
def instances(cls):
instances = []
if not os.path.exists(os.path.join(REGISTRY_DIR, 'tomcat')):
return instances
for instance_name in os.listdir(pki.server.INSTANCE_BASE_DIR):
instance = pki.server.PKIInstance(instance_name)
instance.load()
instances.append(instance)
return instances
class PKISubsystem(object):
def __init__(self, instance, subsystem_name):
self.instance = instance
self.name = subsystem_name
self.type = instance.type
if self.type >= 10:
self.base_dir = os.path.join(self.instance.base_dir, self.name)
else:
self.base_dir = instance.base_dir
self.conf_dir = os.path.join(self.base_dir, 'conf')
self.context_xml_template = os.path.join(
pki.SHARE_DIR, self.name, 'conf', 'Catalina', 'localhost', self.name + '.xml')
self.context_xml = os.path.join(
instance.conf_dir, 'Catalina', 'localhost', self.name + '.xml')
# custom subsystem location
self.doc_base = os.path.join(self.base_dir, 'webapps', self.name)
def is_valid(self):
return os.path.exists(self.conf_dir)
def validate(self):
if not self.is_valid():
raise pki.PKIException(
'Invalid subsystem: ' + self.__repr__(),
None, self.instance)
def is_enabled(self):
return self.instance.is_deployed(self.name)
def enable(self):
if os.path.exists(self.doc_base):
# deploy custom subsystem if exists
doc_base = self.doc_base
else:
# otherwise deploy default subsystem directly from
# /usr/share/pki/<subsystem>/webapps/<subsystem>
doc_base = None
self.instance.deploy(self.name, self.context_xml_template, doc_base)
def disable(self):
self.instance.undeploy(self.name)
def __repr__(self):
return str(self.instance) + '/' + self.name
class PKIInstance(object):
def __init__(self, name, instanceType=10): # nopep8
self.name = name
self.type = instanceType
if self.type >= 10:
self.base_dir = os.path.join(INSTANCE_BASE_DIR, name)
else:
self.base_dir = os.path.join(pki.BASE_DIR, name)
self.conf_dir = os.path.join(self.base_dir, 'conf')
self.lib_dir = os.path.join(self.base_dir, 'lib')
self.registry_dir = os.path.join(
pki.server.REGISTRY_DIR,
'tomcat',
self.name)
self.registry_file = os.path.join(self.registry_dir, self.name)
self.service_name = 'pki-tomcatd@%s.service' % self.name
self.user = None
self.group = None
self.uid = None
self.gid = None
self.subsystems = []
def is_valid(self):
return os.path.exists(self.conf_dir)
def validate(self):
if not self.is_valid():
raise pki.PKIException(
'Invalid instance: ' + self.__repr__(), None)
def start(self):
subprocess.check_call(['systemctl', 'start', self.service_name])
def stop(self):
subprocess.check_call(['systemctl', 'stop', self.service_name])
def is_active(self):
rc = subprocess.call(
['systemctl', '--quiet', 'is-active', self.service_name])
return rc == 0
def load(self):
with open(self.registry_file, 'r') as registry:
lines = registry.readlines()
for line in lines:
m = re.search('^PKI_USER=(.*)$', line)
if m:
self.user = m.group(1)
self.uid = pwd.getpwnam(self.user).pw_uid
m = re.search('^PKI_GROUP=(.*)$', line)
if m:
self.group = m.group(1)
self.gid = grp.getgrnam(self.group).gr_gid
for subsystem_name in os.listdir(self.registry_dir):
if subsystem_name in pki.server.SUBSYSTEM_TYPES:
subsystem = PKISubsystem(self, subsystem_name)
self.subsystems.append(subsystem)
def is_deployed(self, webapp_name):
context_xml = os.path.join(
self.conf_dir, 'Catalina', 'localhost', webapp_name + '.xml')
return os.path.exists(context_xml)
def deploy(self, webapp_name, descriptor, doc_base=None):
"""
Deploy a web application into a Tomcat instance.
This method will copy the specified deployment descriptor into
<instance>/conf/Catalina/localhost/<name>.xml and point the docBase
to the specified location. The web application will become available
under "/<name>" URL path.
See also: http://tomcat.apache.org/tomcat-7.0-doc/config/context.html
:param webapp_name: Web application name.
:type webapp_name: str
:param descriptor: Path to deployment descriptor (context.xml).
:type descriptor: str
:param doc_base: Path to web application content.
:type doc_base: str
"""
context_xml = os.path.join(
self.conf_dir, 'Catalina', 'localhost', webapp_name + '.xml')
# read deployment descriptor
parser = etree.XMLParser(remove_blank_text=True)
document = etree.parse(descriptor, parser)
if doc_base:
# customize docBase
context = document.getroot()
context.set('docBase', doc_base)
# write deployment descriptor
with open(context_xml, 'w') as f:
f.write(etree.tostring(document, pretty_print=True))
# set deployment descriptor ownership and permission
os.chown(context_xml, self.uid, self.gid)
os.chmod(context_xml, 0o0660)
def undeploy(self, webapp_name):
context_xml = os.path.join(
self.conf_dir, 'Catalina', 'localhost', webapp_name + '.xml')
os.remove(context_xml)
def __repr__(self):
if self.type == 9:
return "Dogtag 9 " + self.name
return self.name
class PKIServerException(pki.PKIException):
def __init__(self, message, exception=None,
instance=None, subsystem=None):
pki.PKIException.__init__(self, message, exception)
self.instance = instance
self.subsystem = subsystem
|
