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
|
# Copyright © 2017 Guillem Jover <guillem@debian.org>
#
# 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 <https://www.gnu.org/licenses/>.
=encoding utf8
=head1 NAME
Dpkg::OpenPGP - multi-backend OpenPGP support
=head1 DESCRIPTION
This module provides a class for transparent multi-backend OpenPGP support.
B<Note>: This is a private module, its API can change at any time.
=cut
package Dpkg::OpenPGP 0.01;
use v5.36;
use List::Util qw(none);
use Dpkg::Gettext;
use Dpkg::ErrorHandling;
use Dpkg::IPC;
use Dpkg::Path qw(find_command);
use Dpkg::OpenPGP::ErrorCodes;
my @BACKENDS = qw(
sop
sq
gpg
);
my %BACKEND = (
sop => 'SOP',
sq => 'Sequoia',
gpg => 'GnuPG',
);
sub new {
my ($this, %opts) = @_;
my $class = ref($this) || $this;
my $self = {};
bless $self, $class;
my $backend = $opts{backend} // 'auto';
my %backend_opts = (
cmdv => $opts{cmdv} // 'auto',
cmd => $opts{cmd} // 'auto',
);
if ($backend eq 'auto') {
# Defaults for stateless full API auto-detection.
$opts{needs}{api} //= 'full';
$opts{needs}{keystore} //= 0;
if (none { $opts{needs}{api} eq $_ } qw(full verify)) {
error(g_('unknown OpenPGP api requested %s'), $opts{needs}{api});
}
$self->{backend} = $self->_auto_backend($opts{needs}, %backend_opts);
} elsif (exists $BACKEND{$backend}) {
$self->{backend} = $self->_load_backend($BACKEND{$backend}, %backend_opts);
if (! $self->{backend}) {
error(g_('cannot load OpenPGP backend %s'), $backend);
}
} else {
error(g_('unknown OpenPGP backend %s'), $backend);
}
return $self;
}
sub _load_backend {
my ($self, $backend, %opts) = @_;
my $module = "Dpkg::OpenPGP::Backend::$backend";
eval qq{
require $module;
};
return if $@;
return $module->new(%opts);
}
sub _auto_backend {
my ($self, $needs, %opts) = @_;
foreach my $backend (@BACKENDS) {
my $module = $self->_load_backend($BACKEND{$backend}, %opts);
if ($needs->{api} eq 'verify') {
next if ! $module->has_verify_cmd();
} else {
next if ! $module->has_backend_cmd();
}
next if $needs->{keystore} && ! $module->has_keystore();
return $module;
}
# Otherwise load a dummy backend.
return Dpkg::OpenPGP::Backend->new();
}
sub can_use_secrets {
my ($self, $key) = @_;
return 0 unless $self->{backend}->has_backend_cmd();
return 0 if $key->type eq 'keyfile' && ! -f $key->handle;
return 0 if $key->type eq 'keystore' && ! -e $key->handle;
return 0 unless $self->{backend}->can_use_key($key);
return 1;
}
sub get_trusted_keyrings {
my $self = shift;
return $self->{backend}->get_trusted_keyrings();
}
sub armor {
my ($self, $type, $in, $out) = @_;
return $self->{backend}->armor($type, $in, $out);
}
sub dearmor {
my ($self, $type, $in, $out) = @_;
return $self->{backend}->dearmor($type, $in, $out);
}
sub inline_verify {
my ($self, $inlinesigned, $data, @certs) = @_;
return OPENPGP_MISSING_KEYRINGS if @certs == 0;
return $self->{backend}->inline_verify($inlinesigned, $data, @certs);
}
sub verify {
my ($self, $data, $sig, @certs) = @_;
return OPENPGP_MISSING_KEYRINGS if @certs == 0;
return $self->{backend}->verify($data, $sig, @certs);
}
sub inline_sign {
my ($self, $data, $inlinesigned, $key) = @_;
return $self->{backend}->inline_sign($data, $inlinesigned, $key);
}
=head1 CHANGES
=head2 Version 0.xx
This is a private module.
=cut
1;
|
