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
|
# Copyright © 2021-2022 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::Backend::SOP - OpenPGP backend for SOP
=head1 DESCRIPTION
This module provides a class that implements the OpenPGP backend
for the Stateless OpenPGP Command-Line Interface, as described in
L<https://datatracker.ietf.org/doc/draft-dkg-openpgp-stateless-cli/>.
B<Note>: This is a private module, its API can change at any time.
=cut
package Dpkg::OpenPGP::Backend::SOP 0.01;
use v5.36;
use POSIX qw(:sys_wait_h);
use Dpkg::ErrorHandling;
use Dpkg::IPC;
use Dpkg::OpenPGP::ErrorCodes;
use parent qw(Dpkg::OpenPGP::Backend);
# - Once "hop" implements the new SOP draft, add as alternative.
# Ref: https://salsa.debian.org/clint/hopenpgp-tools/-/issues/4
# - Once the SOP MR !23 is finalized and merged, implement a way to select
# whether the SOP instance supports the expected draft.
# Ref: https://gitlab.com/dkg/openpgp-stateless-cli/-/merge_requests/23
# - Once the SOP issue #42 is resolved we can perhaps remove the alternative
# dependencies and commands to check?
# Ref: https://gitlab.com/dkg/openpgp-stateless-cli/-/issues/42
sub DEFAULT_CMDV {
return [ qw(sqopv rsopv sopv) ];
}
sub DEFAULT_CMD {
return [ qw(sqop rsop gosop pgpainless-cli) ];
}
sub _sop_exec
{
my ($self, %sop) = @_;
my $cmd;
if ($sop{verify}) {
$cmd = $self->{cmdv} || $self->{cmd};
} else {
$cmd = $self->{cmd};
}
return OPENPGP_MISSING_CMD unless $cmd;
$sop{out} //= '/dev/null';
my $stderr;
spawn(
exec => [ $cmd, @{$sop{args}} ],
wait_child => 1,
no_check => 1,
timeout => 10,
from_file => $sop{in},
to_file => $sop{out},
error_to_string => \$stderr,
);
if (WIFEXITED($?)) {
my $status = WEXITSTATUS($?);
print { *STDERR } "$stderr" if $status;
return $status;
} else {
subprocerr("$cmd @{$sop{args}}");
}
}
# XXX: We cannot use the SOP armor/dearmor interfaces, because concatenated
# ASCII Armor is not a well supported construct, and not all SOP
# implementations support. But we still need to handle this given the
# data we are managing. Remove these implementations for now and use
# the generic parent implementations. Once we can guarantee that our
# data has been sanitized, then we could switch back to use pure SOP
# interfaces.
sub inline_verify
{
my ($self, $inlinesigned, $data, @certs) = @_;
return OPENPGP_MISSING_KEYRINGS if @certs == 0;
return $self->_sop_exec(
args => [ 'inline-verify', @certs ],
verify => 1,
in => $inlinesigned,
out => $data,
);
}
sub verify
{
my ($self, $data, $sig, @certs) = @_;
return OPENPGP_MISSING_KEYRINGS if @certs == 0;
return $self->_sop_exec(
args => [ 'verify', $sig, @certs ],
verify => 1,
in => $data,
);
}
sub inline_sign
{
my ($self, $data, $inlinesigned, $key) = @_;
return OPENPGP_NEEDS_KEYSTORE if $key->needs_keystore();
return $self->_sop_exec(
args => [ qw(inline-sign --as clearsigned --), $key->handle ],
in => $data,
out => $inlinesigned,
);
}
=head1 CHANGES
=head2 Version 0.xx
This is a private module.
=cut
1;
|