Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

# Authors: Rob Crittenden <rcritten@redhat.com> 

# 

# Copyright (C) 2009    Red Hat 

# see file 'COPYING' for use and warranty information 

# 

# 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, either version 3 of the License, or 

# (at your option) any later version. 

# 

# 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, see <http://www.gnu.org/licenses/>. 

# 

 

import os 

import httplib 

import xml.dom.minidom 

import ConfigParser 

from urllib import urlencode 

 

import nss.nss as nss 

from nss.error import NSPRError 

 

from ipalib import api, errors 

from ipalib.errors import NetworkError, CertificateOperationError 

from ipalib.text import _ 

from ipapython import nsslib, ipautil 

from ipapython.ipa_log_manager import * 

 

# IPA can use either Dogtag version 9 or 10. 

# 

# Install tools should use the constants from install_constants, so that they 

# install with version 10 if it is available, and with 9 if not. 

# After IPA installation, the Dogtag version used is stored in the 

# "dogtag_version" config option. (If that is missing, version 9 is assumed.) 

# The configured_constants() function below provides constants relevant to 

# the configured version. 

 

class Dogtag10Constants(object): 

    DOGTAG_VERSION = 10 

    UNSECURE_PORT = 8080 

    AGENT_SECURE_PORT = 8443 

    EE_SECURE_PORT = 8443 

    AJP_PORT = 8009 

    DS_PORT = 389 

    DS_SECURE_PORT = 636 

 

    SPAWN_BINARY = '/usr/sbin/pkispawn' 

    DESTROY_BINARY = '/usr/sbin/pkidestroy' 

 

    SERVER_ROOT = '/var/lib/pki' 

    PKI_INSTANCE_NAME = 'pki-tomcat' 

    PKI_ROOT = '%s/%s' % (SERVER_ROOT, PKI_INSTANCE_NAME) 

    CRL_PUBLISH_PATH = '/var/lib/ipa/pki-ca/publish' 

    CS_CFG_PATH = '%s/conf/ca/CS.cfg' % PKI_ROOT 

    PASSWORD_CONF_PATH = '%s/conf/password.conf' % PKI_ROOT 

    SERVICE_PROFILE_DIR = '%s/ca/profiles/ca' % PKI_ROOT 

    ALIAS_DIR = '/etc/pki/pki-tomcat/alias' 

 

    RACERT_LINE_SEP = '\n' 

 

    IPA_SERVICE_PROFILE = '%s/caIPAserviceCert.cfg' % SERVICE_PROFILE_DIR 

    SIGN_PROFILE = '%s/caJarSigningCert.cfg' % SERVICE_PROFILE_DIR 

    SHARED_DB = True 

    DS_USER = "dirsrv" 

    DS_NAME = "dirsrv" 

 

 

class Dogtag9Constants(object): 

    DOGTAG_VERSION = 9 

    UNSECURE_PORT = 9180 

    AGENT_SECURE_PORT = 9443 

    EE_SECURE_PORT = 9444 

    AJP_PORT = 9447 

    DS_PORT = 7389 

    DS_SECURE_PORT = 7636 

 

    SPAWN_BINARY = '/bin/pkicreate' 

    DESTROY_BINARY = '/bin/pkisilent' 

 

    SERVER_ROOT = '/var/lib' 

    PKI_INSTANCE_NAME = 'pki-ca' 

    PKI_ROOT = '%s/%s' % (SERVER_ROOT, PKI_INSTANCE_NAME) 

    CRL_PUBLISH_PATH = '/var/lib/ipa/pki-ca/publish' 

    CS_CFG_PATH = '%s/conf/CS.cfg' % PKI_ROOT 

    PASSWORD_CONF_PATH = '%s/conf/password.conf' % PKI_ROOT 

    SERVICE_PROFILE_DIR = '%s/profiles/ca' % PKI_ROOT 

    ALIAS_DIR = '%s/alias' % PKI_ROOT 

 

    RACERT_LINE_SEP = '\r\n' 

 

    ADMIN_SECURE_PORT = 9445 

    EE_CLIENT_AUTH_PORT = 9446 

    TOMCAT_SERVER_PORT = 9701 

 

    IPA_SERVICE_PROFILE = '%s/caIPAserviceCert.cfg' % SERVICE_PROFILE_DIR 

    SIGN_PROFILE = '%s/caJarSigningCert.cfg' % SERVICE_PROFILE_DIR 

    SHARED_DB = False 

    DS_USER = "pkisrv" 

    DS_NAME = "PKI-IPA" 

 

if os.path.exists('/usr/sbin/pkispawn'): 

    install_constants = Dogtag10Constants 

else: 

    install_constants = Dogtag9Constants 

 

 

def _get_configured_version(api): 

    """Get the version of Dogtag IPA is configured to use 

 

    If an API is given, use information in its environment. 

    Otherwise, use information from the global config file. 

    """ 

    if api: 

        return int(api.env.dogtag_version) 

    else: 

        p = ConfigParser.SafeConfigParser() 

        p.read("/etc/ipa/default.conf") 

        try: 

            version = p.get('global', 'dogtag_version') 

        except (ConfigParser.NoOptionError, ConfigParser.NoSectionError): 

            return 9 

        else: 

            return int(version) 

 

 

def configured_constants(api=None): 

    """Get the name of the Dogtag CA instance 

 

    See get_configured_version 

    """ 

    if _get_configured_version(api) >= 10: 

        return Dogtag10Constants 

    else: 

        return Dogtag9Constants 

 

 

def error_from_xml(doc, message_template): 

    try: 

        item_node = doc.getElementsByTagName("Error") 

        reason = item_node[0].childNodes[0].data 

        return errors.RemoteRetrieveError(reason=reason) 

    except Exception, e: 

        return errors.RemoteRetrieveError(reason=message_template % e) 

 

 

def get_ca_certchain(ca_host=None, dogtag_constants=None): 

    """ 

    Retrieve the CA Certificate chain from the configured Dogtag server. 

    """ 

    if ca_host is None: 

        ca_host = api.env.ca_host 

    if dogtag_constants is None: 

        dogtag_constants = configured_constants() 

    chain = None 

    conn = httplib.HTTPConnection(ca_host, 

        api.env.ca_install_port or dogtag_constants.UNSECURE_PORT) 

    conn.request("GET", "/ca/ee/ca/getCertChain") 

    res = conn.getresponse() 

    doc = None 

    if res.status == 200: 

        data = res.read() 

        conn.close() 

        try: 

            doc = xml.dom.minidom.parseString(data) 

            try: 

                item_node = doc.getElementsByTagName("ChainBase64") 

                chain = item_node[0].childNodes[0].data 

            except IndexError: 

                raise error_from_xml( 

                    doc, _("Retrieving CA cert chain failed: %s")) 

        finally: 

            if doc: 

                doc.unlink() 

    else: 

        raise errors.RemoteRetrieveError( 

            reason=_("request failed with HTTP status %d") % res.status) 

 

    return chain 

 

 

def ca_status(ca_host=None): 

    """Return the status of the CA, and the httpd proxy in front of it 

 

    The returned status can be: 

    - running 

    - starting 

    - Service Temporarily Unavailable 

    """ 

    if ca_host is None: 

        ca_host = api.env.ca_host 

    # Use port 443 to test the proxy as well 

    status, reason, headers, body = unauthenticated_https_request( 

        ca_host, 443, '/ca/admin/ca/getStatus') 

    if status == 503: 

        # Service temporarily unavailable 

        return reason 

    elif status != 200: 

        raise errors.RemoteRetrieveError( 

            reason=_("Retrieving CA status failed: %s") % reason) 

    doc = xml.dom.minidom.parseString(body) 

    try: 

        item_node = doc.getElementsByTagName("XMLResponse")[0] 

        item_node = item_node.getElementsByTagName("Status")[0] 

        return item_node.childNodes[0].data 

    except IndexError: 

        raise error_from_xml(doc, _("Retrieving CA status failed: %s")) 

 

 

def https_request(host, port, url, secdir, password, nickname, **kw): 

    """ 

    :param url: The path (not complete URL!) to post to. 

    :param kw:  Keyword arguments to encode into POST body. 

    :return:   (http_status, http_reason_phrase, http_headers, http_body) 

               as (integer, unicode, dict, str) 

 

    Perform a client authenticated HTTPS request 

    """ 

 

    def connection_factory(host, port): 

        conn = nsslib.NSSConnection(host, port, dbdir=secdir) 

        conn.set_debuglevel(0) 

        conn.connect() 

        conn.sock.set_client_auth_data_callback( 

            nsslib.client_auth_data_callback, 

            nickname, password, nss.get_default_certdb()) 

        return conn 

 

    body = urlencode(kw) 

    return _httplib_request( 

            'https', host, port, url, connection_factory, body) 

 

 

def http_request(host, port, url, **kw): 

    """ 

    :param url: The path (not complete URL!) to post to. 

    :param kw: Keyword arguments to encode into POST body. 

    :return:   (http_status, http_reason_phrase, http_headers, http_body) 

                as (integer, unicode, dict, str) 

 

    Perform an HTTP request. 

    """ 

    body = urlencode(kw) 

    return _httplib_request( 

        'http', host, port, url, httplib.HTTPConnection, body) 

 

 

def unauthenticated_https_request(host, port, url, **kw): 

    """ 

    :param url: The path (not complete URL!) to post to. 

    :param kw: Keyword arguments to encode into POST body. 

    :return:   (http_status, http_reason_phrase, http_headers, http_body) 

                as (integer, unicode, dict, str) 

 

    Perform an unauthenticated HTTPS request. 

    """ 

    body = urlencode(kw) 

    return _httplib_request( 

        'https', host, port, url, httplib.HTTPSConnection, body) 

 

 

def _httplib_request( 

        protocol, host, port, path, connection_factory, request_body): 

    """ 

    :param request_body: Request body 

    :param connection_factory: Connection class to use. Will be called 

        with the host and port arguments. 

 

    Perform a HTTP(s) request. 

    """ 

    if isinstance(host, unicode): 

        host = host.encode('utf-8') 

    uri = '%s://%s%s' % (protocol, ipautil.format_netloc(host, port), path) 

    root_logger.debug('request %r', uri) 

    root_logger.debug('request body %r', request_body) 

    try: 

        conn = connection_factory(host, port) 

        conn.request('POST', uri, 

            body=request_body, 

            headers={'Content-type': 'application/x-www-form-urlencoded'}, 

        ) 

        res = conn.getresponse() 

 

        http_status = res.status 

        http_reason_phrase = unicode(res.reason, 'utf-8') 

        http_headers = res.msg.dict 

        http_body = res.read() 

        conn.close() 

    except Exception, e: 

        raise NetworkError(uri=uri, error=str(e)) 

 

    root_logger.debug('request status %d',        http_status) 

    root_logger.debug('request reason_phrase %r', http_reason_phrase) 

    root_logger.debug('request headers %s',       http_headers) 

    root_logger.debug('request body %r',          http_body) 

 

    return http_status, http_reason_phrase, http_headers, http_body