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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
|
<?php
/* $Id$ */
/*
Copyright (C) 2008 Shrew Soft Inc
Copyright (C) 2010 Jim Pingle <jimp@pfsense.org>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
DISABLE_PHP_LINT_CHECKING
pfSense_MODULE: certificate_managaer
*/
require_once("functions.inc");
function & lookup_ca($refid) {
global $config;
if (is_array($config['ca']))
foreach ($config['ca'] as & $ca)
if ($ca['refid'] == $refid)
return $ca;
return false;
}
function & lookup_ca_by_subject($subject) {
global $config;
if (is_array($config['ca']))
foreach ($config['ca'] as & $ca)
{
$ca_subject = cert_get_subject($ca['crt']);
if ($ca_subject == $subject)
return $ca;
}
return false;
}
function & lookup_cert($refid) {
global $config;
if (is_array($config['cert']))
foreach ($config['cert'] as & $cert)
if ($cert['refid'] == $refid)
return $cert;
return false;
}
function & lookup_cert_by_name($name) {
global $config;
if (is_array($config['cert']))
foreach ($config['cert'] as & $cert)
if ($cert['descr'] == $name)
return $cert;
}
function & lookup_crl($refid) {
global $config;
if (is_array($config['crl']))
foreach ($config['crl'] as & $crl)
if ($crl['refid'] == $refid)
return $crl;
return false;
}
function ca_chain_array(& $cert) {
if($cert['caref']) {
$chain = array();
$crt = lookup_ca($cert['caref']);
$chain[] = $crt;
while ($crt) {
$caref = $crt['caref'];
if($caref)
$crt = lookup_ca($caref);
else
$crt = false;
if($crt)
$chain[] = $crt;
}
return $chain;
}
return false;
}
function ca_chain(& $cert) {
if($cert['caref']) {
$ca = "";
$cas = ca_chain_array($cert);
if (is_array($cas))
foreach ($cas as & $ca_cert)
{
$ca .= base64_decode($ca_cert['crt']);
$ca .= "\n";
}
return $ca;
}
return "";
}
function ca_import(& $ca, $str, $key="") {
global $config;
$ca['crt'] = base64_encode($str);
if (!empty($key))
$ca['prv'] = base64_encode($key);
$subject = cert_get_subject($str, false);
$issuer = cert_get_issuer($str, false);
// Find my issuer unless self-signed
if($issuer <> $subject) {
$issuer_crt =& lookup_ca_by_subject($issuer);
if($issuer_crt)
$ca['caref'] = $issuer_crt['refid'];
}
/* Correct if child certificate was loaded first */
if (is_array($config['ca']))
foreach ($config['ca'] as & $oca)
{
$issuer = cert_get_issuer($oca['crt']);
if($ca['refid']<>$oca['refid'] && $issuer==$subject)
$oca['caref'] = $ca['refid'];
}
if (is_array($config['cert']))
foreach ($config['cert'] as & $cert)
{
$issuer = cert_get_issuer($cert['crt']);
if($issuer==$subject)
$cert['caref'] = $ca['refid'];
}
return true;
}
function ca_create(& $ca, $keylen, $lifetime, $dn) {
$args = array(
"digest_alg" => "sha1",
"private_key_bits" => (int)$keylen,
"private_key_type" => OPENSSL_KEYTYPE_RSA,
"encrypt_key" => false);
// generate a new key pair
$res_key = openssl_pkey_new($args);
// generate a certificate signing request
$res_csr = openssl_csr_new($dn, $res_key, $args);
// self sign the certificate
$res_crt = openssl_csr_sign($res_csr, null, $res_key, $lifetime, $args);
// export our certificate data
openssl_pkey_export($res_key, $str_key);
openssl_x509_export($res_crt, $str_crt);
// return our ca information
$ca['crt'] = base64_encode($str_crt);
$ca['prv'] = base64_encode($str_key);
$ca['serial'] = 0;
return true;
}
function cert_import(& $cert, $crt_str, $key_str) {
$cert['crt'] = base64_encode($crt_str);
$cert['prv'] = base64_encode($key_str);
$subject = cert_get_subject($crt_str, false);
$issuer = cert_get_issuer($crt_str, false);
// Find my issuer unless self-signed
if($issuer <> $subject) {
$issuer_crt =& lookup_ca_by_subject($issuer);
if($issuer_crt)
$cert['caref'] = $issuer_crt['refid'];
}
return true;
}
function cert_create(& $cert, $caref, $keylen, $lifetime, $dn) {
$ca =& lookup_ca($caref);
if (!$ca)
return false;
$ca_str_crt = base64_decode($ca['crt']);
$ca_str_key = base64_decode($ca['prv']);
$ca_res_crt = openssl_x509_read($ca_str_crt);
$ca_res_key = openssl_pkey_get_private(array(0 => $ca_str_key, 1 => ""));
$ca_serial = ++$ca['serial'];
$args = array(
"digest_alg" => "sha1",
"private_key_bits" => (int)$keylen,
"private_key_type" => OPENSSL_KEYTYPE_RSA,
"encrypt_key" => false);
// generate a new key pair
$res_key = openssl_pkey_new($args);
// generate a certificate signing request
$res_csr = openssl_csr_new($dn, $res_key, $args);
// self sign the certificate
$res_crt = openssl_csr_sign($res_csr, $ca_res_crt, $ca_res_key, $lifetime,
$args, $ca_serial);
// export our certificate data
openssl_pkey_export($res_key, $str_key);
openssl_x509_export($res_crt, $str_crt);
// return our certificate information
$cert['caref'] = $caref;
$cert['crt'] = base64_encode($str_crt);
$cert['prv'] = base64_encode($str_key);
return true;
}
function csr_generate(& $cert, $keylen, $dn) {
$args = array(
"digest_alg" => "sha1",
"private_key_bits" => (int)$keylen,
"private_key_type" => OPENSSL_KEYTYPE_RSA,
"encrypt_key" => false);
// generate a new key pair
$res_key = openssl_pkey_new($args);
// generate a certificate signing request
$res_csr = openssl_csr_new($dn, $res_key, $args);
// export our request data
openssl_pkey_export($res_key, $str_key);
openssl_csr_export($res_csr, $str_csr);
// return our request information
$cert['csr'] = base64_encode($str_csr);
$cert['prv'] = base64_encode($str_key);
return true;
}
function csr_complete(& $cert, $str_crt) {
// return our request information
$cert['crt'] = base64_encode($str_crt);
unset($cert['csr']);
return true;
}
function csr_get_subject($str_crt, $decode = true) {
if ($decode)
$str_crt = base64_decode($str_crt);
$components = openssl_csr_get_subject($str_crt);
if (!is_array($components))
return "unknown";
ksort($components);
foreach ($components as $a => $v) {
if (!strlen($subject))
$subject = "{$a}={$v}";
else
$subject = "{$a}={$v}, {$subject}";
}
return $subject;
}
function cert_get_subject($str_crt, $decode = true) {
if ($decode)
$str_crt = base64_decode($str_crt);
$inf_crt = openssl_x509_parse($str_crt);
$components = $inf_crt['subject'];
if (!is_array($components))
return "unknown";
ksort($components);
foreach ($components as $a => $v) {
if (is_array($v)) {
ksort($v);
foreach ($v as $w) {
$asubject = "{$a}={$w}";
$subject = (strlen($subject)) ? "{$asubject}, {$subject}" : $asubject;
}
} else {
$asubject = "{$a}={$v}";
$subject = (strlen($subject)) ? "{$asubject}, {$subject}" : $asubject;
}
}
return $subject;
}
function cert_get_subject_array($crt) {
$str_crt = base64_decode($crt);
$inf_crt = openssl_x509_parse($str_crt);
$components = $inf_crt['subject'];
if (!is_array($components))
return;
$subject_array = array();
foreach($components as $a => $v)
$subject_array[] = array('a' => $a, 'v' => $v);
return $subject_array;
}
function cert_get_subject_hash($crt) {
$str_crt = base64_decode($crt);
$inf_crt = openssl_x509_parse($str_crt);
return $inf_crt['subject'];
}
function cert_get_issuer($str_crt, $decode = true) {
if ($decode)
$str_crt = base64_decode($str_crt);
$inf_crt = openssl_x509_parse($str_crt);
$components = $inf_crt['issuer'];
if (!is_array($components))
return "unknown";
foreach ($components as $a => $v) {
if (!strlen($issuer))
$issuer = "{$a}={$v}";
else
$issuer = "{$a}={$v}, {$issuer}";
}
return $issuer;
}
function is_user_cert($certref) {
global $config;
if (!is_array($config['system']['user']))
return;
foreach ($config['system']['user'] as $user) {
if (!is_array($user['cert']))
continue;
foreach ($user['cert'] as $cert) {
if ($certref == $cert)
return true;
}
}
return false;
}
function is_openvpn_server_cert($certref) {
global $config;
if (!is_array($config['openvpn']['openvpn-server']))
return;
foreach ($config['openvpn']['openvpn-server'] as $ovpns) {
if ($ovpns['certref'] == $certref)
return true;
}
return false;
}
function is_openvpn_client_cert($certref) {
global $config;
if (!is_array($config['openvpn']['openvpn-client']))
return;
foreach ($config['openvpn']['openvpn-client'] as $ovpnc) {
if ($ovpnc['certref'] == $certref)
return true;
}
return false;
}
function is_ipsec_cert($certref) {
global $config;
if (!is_array($config['ipsec']['phase1']))
return;
foreach ($config['ipsec']['phase1'] as $ipsec) {
if ($ipsec['certref'] == $certref)
return true;
}
return false;
}
function is_webgui_cert($certref) {
global $config;
if ($config['system']['webgui']['ssl-certref'] == $certref)
return true;
}
function cert_in_use($certref) {
return (is_webgui_cert($certref) ||
is_user_cert($certref) ||
is_openvpn_server_cert($certref) ||
is_openvpn_client_cert($certref) ||
is_ipsec_cert($certref));
}
/*
CRL code is a *WORK IN PROGRESS* do not try to use these functions yet.
OpenSSL CRL status code constants.
OCSP_REVOKED_STATUS_NOSTATUS
OCSP_REVOKED_STATUS_UNSPECIFIED
OCSP_REVOKED_STATUS_KEYCOMPROMISE
OCSP_REVOKED_STATUS_CACOMPROMISE
OCSP_REVOKED_STATUS_AFFILIATIONCHANGED
OCSP_REVOKED_STATUS_SUPERSEDED
OCSP_REVOKED_STATUS_CESSATIONOFOPERATION
OCSP_REVOKED_STATUS_CERTIFICATEHOLD
OCSP_REVOKED_STATUS_REMOVEFROMCRL
*/
$openssl_crl_status = array(
OCSP_REVOKED_STATUS_NOSTATUS => "No Status (default)",
OCSP_REVOKED_STATUS_UNSPECIFIED => "Unspecified",
OCSP_REVOKED_STATUS_KEYCOMPROMISE => "Key Compromise",
OCSP_REVOKED_STATUS_CACOMPROMISE => "CA Compromise",
OCSP_REVOKED_STATUS_AFFILIATIONCHANGED => "Affiliation Changed",
OCSP_REVOKED_STATUS_SUPERSEDED => "Superseded",
OCSP_REVOKED_STATUS_CESSATIONOFOPERATION => "Cessation of Operation",
OCSP_REVOKED_STATUS_CERTIFICATEHOLD => "Certificate Hold"
);
function crl_create(& $crl, $caref, $name, $serial=0, $lifetime=9999) {
global $config;
$ca =& lookup_ca($caref);
if (!$ca)
return false;
$crl['descr'] = $name;
$crl['caref'] = $caref;
$crl['serial'] = $serial;
$crl['lifetime'] = $lifetime;
$crl['cert'] = array();
$crl_res = crl_update($crl);
$config['crl'][] = $crl;
return $crl_res;
}
function crl_update(& $crl) {
global $config;
$ca =& lookup_ca($crl['caref']);
if (!$ca)
return false;
// If we have text but no certs, it was imported and cannot be updated.
if (!empty($crl['text']) && empty($crl['cert']))
return false;
$crl['serial']++;
$ca_str_crt = base64_decode($ca['crt']);
$ca_str_key = base64_decode($ca['prv']);
$crl_res = openssl_crl_new($ca_str_crt, $crl['serial'], $crl['lifetime']);
foreach ($crl['cert'] as $cert) {
openssl_crl_revoke_cert($crl_res, base64_decode($cert["crt"]), $cert["revoke_time"], $cert["reason"]);
}
openssl_crl_export($crl_res, $crl_text, $ca_str_key);
$crl['text'] = base64_encode($crl_text);
return $crl_res;
}
function cert_revoke($cert, & $crl, $reason=OCSP_REVOKED_STATUS_UNSPECIFIED) {
global $config;
if (is_cert_revoked($cert, $crl['refid']))
return true;
// If we have text but no certs, it was imported and cannot be updated.
if (!is_crl_internal($crl))
return false;
$cert["reason"] = $reason;
$cert["revoke_time"] = time();
$crl["cert"][] = $cert;
crl_update($crl);
return true;
}
function cert_unrevoke($cert, & $crl) {
global $config;
if (!is_crl_internal($crl))
return false;
foreach ($crl['cert'] as $id => $rcert) {
if (($rcert['refid'] == $cert['refid']) || ($rcert['descr'] == $cert['descr'])) {
unset($crl['cert'][$id]);
crl_update($crl);
return true;
}
}
return false;
}
function is_cert_revoked($cert, $crlref = "") {
global $config;
if (!is_array($config['crl']))
return false;
if (!empty($crlref)) {
$crl = lookup_crl($crlref);
if (!is_array($crl['cert']))
return false;
foreach ($crl['cert'] as $rcert) {
if (($rcert['refid'] == $cert['refid']) || ($rcert['descr'] == $cert['descr']))
return true;
}
} else {
foreach ($config['crl'] as $crl) {
if (!is_array($crl['cert']))
continue;
foreach ($crl['cert'] as $rcert) {
if (($rcert['refid'] == $cert['refid']) || ($rcert['descr'] == $cert['descr']))
return true;
}
}
}
return false;
}
function is_openvpn_server_crl($crlref) {
global $config;
if (!is_array($config['openvpn']['openvpn-server']))
return;
foreach ($config['openvpn']['openvpn-server'] as $ovpns) {
if (!empty($ovpns['crlref']) && ($ovpns['crlref'] == $crlref))
return true;
}
return false;
}
// Keep this general to allow for future expansion. See cert_in_use() above.
function crl_in_use($crlref) {
return (is_openvpn_server_crl($crlref));
}
function is_crl_internal($crl) {
return !(!empty($crl['text']) && empty($crl['cert']));
}
?>
|