SMIME.pm 7.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
# -*- indent-tabs-mode: nil; -*-
# vim:ft=perl:et:sw=4
# $Id$

# Sympa - SYsteme de Multi-Postage Automatique
#
# Copyright (c) 1997, 1998, 1999 Institut Pasteur & Christophe Wolfhugel
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
10
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#
# 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 2 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/>.

package Sympa::Tools::SMIME;

use strict;
use warnings;
use English qw(-no_match_vars);

use Conf;
32
33
34
use Sympa::Log;

my $log = Sympa::Log->instance;
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

=over

=item find_keys ( $that, $operation )

Find the appropriate S/MIME keys/certs for $operation of $that.

$operation can be:

=over

=item 'sign'

return the preferred signing key/cert

=item 'decrypt'

return a list of possible decryption keys/certs

=item 'encrypt'

return the preferred encryption key/cert

=back

Returnss C<($certs, $keys)>.
For 'sign' and 'encrypt', these are strings containing the absolute filename.
For 'decrypt', these are arrayrefs containing absolute filenames.

=back

=cut

# Old name: tools::smime_find_keys()
sub find_keys {
70
    $log->syslog('debug2', '(%s, %s)', @_);
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
    my $that = shift || '*';
    my $operation = shift;

    my $dir;
    if (ref $that eq 'Sympa::List') {
        $dir = $that->{'dir'};
    } else {
        $dir = $Conf::Conf{'home'} . '/sympa';    #FIXME
    }

    my (%certs, %keys);
    my $ext = ($operation eq 'sign' ? 'sign' : 'enc');

    unless (opendir(D, $dir)) {
        return undef;
    }

    while (my $fn = readdir(D)) {
        if ($fn =~ /^cert\.pem/) {
            $certs{"$dir/$fn"} = 1;
        } elsif ($fn =~ /^private_key/) {
            $keys{"$dir/$fn"} = 1;
        }
    }
    closedir(D);

    foreach my $c (keys %certs) {
        my $k = $c;
        $k =~ s/\/cert\.pem/\/private_key/;
        unless ($keys{$k}) {
101
            $log->syslog('debug3', '%s exists, but matching %s doesn\'t',
102
103
104
105
106
107
108
109
110
                $c, $k);
            delete $certs{$c};
        }
    }

    foreach my $k (keys %keys) {
        my $c = $k;
        $c =~ s/\/private_key/\/cert\.pem/;
        unless ($certs{$c}) {
111
            $log->syslog('debug3', '%s exists, but matching %s doesn\'t',
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
                $k, $c);
            delete $keys{$k};
        }
    }

    my ($certs, $keys);
    if ($operation eq 'decrypt') {
        $certs = [sort keys %certs];
        $keys  = [sort keys %keys];
    } else {
        if ($certs{"$dir/cert.pem.$ext"}) {
            $certs = "$dir/cert.pem.$ext";
            $keys  = "$dir/private_key.$ext";
        } elsif ($certs{"$dir/cert.pem"}) {
            $certs = "$dir/cert.pem";
            $keys  = "$dir/private_key";
        } else {
129
            $log->syslog('debug3', '%s: no certs/keys found for %s',
130
131
132
133
134
                $that, $operation);
            return undef;
        }
    }

135
    $log->syslog('debug3', '%s: certs/keys for %s found', $that, $operation);
136
137
138
    return ($certs, $keys);
}

139
140
141
142
BEGIN {
    eval 'use Crypt::OpenSSL::X509';
    eval 'use Convert::ASN1 qw()';
}
143
144
145
146
147
148
149
150
151
152
153
154
155

# IN: hashref:
# file => filename
# text => PEM-encoded cert
# OUT: hashref
# email => email address from cert
# subject => distinguished name
# purpose => hashref
#  enc => true if v3 purpose is encryption
#  sign => true if v3 purpose is signing
#
# Old name: tools::smime_parse_cert()
sub parse_cert {
156
    $log->syslog('debug3', '(%s => %s)', @_);
157
158
    my %arg = @_;

159
160
    return undef unless $Crypt::OpenSSL::X509::VERSION;

161
162
163
164
165
166
167
    ## Load certificate
    my $x509;
    if ($arg{'text'}) {
        $x509 = eval { Crypt::OpenSSL::X509->new_from_string($arg{'text'}) };
    } elsif ($arg{'file'}) {
        $x509 = eval { Crypt::OpenSSL::X509->new_from_file($arg{'file'}) };
    } else {
168
        $log->syslog('err', 'Neither "text" nor "file" given');
169
170
171
        return undef;
    }
    unless ($x509) {
172
        $log->syslog('err', 'Cannot parse certificate');
173
174
175
176
177
178
        return undef;
    }

    my %res;
    $res{subject} = join '',
        map { '/' . $_->as_string } @{$x509->subject_name->entries};
179
180
181
182
183
184
185

    # Get email(s).
    # The subjectAltName extension is used. The email() method that gives
    # single address may be used for workaround on malformed certificates.
    my @emails = _get_subjectAltName($x509, 1);    # rfc822Name [1]
    unless (@emails) {
        @emails = ($x509->email) if $x509->email;
186
    }
187
188
189
    $res{email} =
        {map { (Sympa::Tools::Text::canonic_email($_) => 1) } @emails};

190
191
192
193
194
195
196
    # Check key usage roughy.
    my %purposes = $x509->extensions_by_name->{keyUsage}->hash_bit_string;
    $res{purpose}->{sign} = $purposes{'Digital Signature'} ? 1 : '';
    $res{purpose}->{enc}  = $purposes{'Key Encipherment'}  ? 1 : '';
    return \%res;
}

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
sub _get_subjectAltName {
    my $x509        = shift;
    my $context_num = shift;

    my $extensions = $x509->extensions_by_name;

    return
            unless $extensions
        and $extensions->{subjectAltName}
        and $extensions->{subjectAltName}->value =~ /\A#([0-9A-F]+)\z/;

    my $bin = pack 'H*', $1;
    my ($tag, $tnum, $len);

    ($tag, $tnum, $bin, $len) = _parse_asn1_single_value($bin);
    return
        unless defined $tag
        and ($tag & ~Convert::ASN1::ASN_CONSTRUCTOR()) ==
        Convert::ASN1::ASN_SEQUENCE();

    my @ret;
    while (length $bin) {
        my $val;
        ($tag, $tnum, $val, $len) = _parse_asn1_single_value($bin);
        last unless defined $tag;
        $bin = substr $bin, $len;
        next if $tag == 0 and length $val == 0;

        push @ret, $val
            if ($tag & 0xC0) == Convert::ASN1::ASN_CONTEXT()
            and $tnum == $context_num;
    }
    return @ret;
}

sub _parse_asn1_single_value {
    my $bin = shift;

    my ($tb, $tag, $tnum) =
        Convert::ASN1::asn_decode_tag2(substr $bin, 0, 10);
    return unless defined $tb;
    my ($lb, $len) = Convert::ASN1::asn_decode_length(substr $bin, $tb, 10);
    return unless $tb + $lb + $len <= length $bin;

    return ($tag, $tnum, substr($bin, $tb + $lb, $len), $tb + $lb + $len);
}

244
245
246
247
248
# NO LONGER USED
# However, this function may be useful because it can extract messages openssl
# can not (e.g. signature part not encoded by BASE64).
sub smime_extract_certs {
    my ($mime, $outfile) = @_;
249
    $log->syslog('debug2', '(%s)', $mime->mime_type);
250
251
252
253
254
255
256
257

    if ($mime->mime_type =~ /application\/(x-)?pkcs7-/) {
        my $pipeout;
        unless (
            open $pipeout,
            '|-', $Conf::Conf{openssl}, 'pkcs7', '-print_certs',
            '-inform' => 'der',
            '-out'    => $outfile
Luc Didry's avatar
Luc Didry committed
258
        ) {
259
            $log->syslog('err', 'Unable to run openssl pkcs7: %m');
260
261
262
263
264
265
            return 0;
        }
        print $pipeout $mime->bodyhandle->as_string;
        close $pipeout;
        my $status = $CHILD_ERROR >> 8;
        if ($status) {
266
            $log->syslog('err', 'Openssl pkcs7 returned an error: %s',
267
268
269
270
271
272
273
274
                $status);
            return 0;
        }
        return 1;
    }
}

1;