summaryrefslogtreecommitdiffstats
path: root/scripts/Dpkg/OpenPGP/KeyHandle.pm
blob: 9c843e4fa82dc274bf4598699dcd275b18818d89 (plain)
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
# Copyright © 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::KeyHandle - OpenPGP key handle support

=head1 DESCRIPTION

This module provides a class to hold an OpenPGP key handle, as a way for
the code to refer to a key in an independent way.

B<Note>: This is a private module, its API can change at any time.

=cut

package Dpkg::OpenPGP::KeyHandle 0.01;

use strict;
use warnings;

use Carp;
use List::Util qw(any none);

sub new {
    my ($this, %opts) = @_;
    my $class = ref($this) || $this;

    my $self = {
        type => $opts{type} // 'auto',
        handle => $opts{handle},
    };
    bless $self, $class;

    $self->_sanitize();

    return $self;
}

my $keyid_regex = qr/^(?:0x)?([[:xdigit:]]+)$/;

sub _sanitize {
    my ($self) = shift;

    my $type = $self->{type};
    if ($type eq 'auto') {
        if (-e $self->{handle}) {
            $type = 'keyfile';
        } else {
            $type = 'autoid';
        }
    }

    if ($type eq 'autoid') {
        if ($self->{handle} =~ m/$keyid_regex/) {
            $self->{handle} = $1;
            $type = 'keyid';
        } else {
            $type = 'userid';
        }
        $self->{type} = $type;
    } elsif ($type eq 'keyid') {
        if ($self->{handle} =~ m/$keyid_regex/) {
            $self->{handle} = $1;
        }
    }

    if (none { $type eq $_ } qw(userid keyid keyfile keystore)) {
        croak "unknown type parameter value $type";
    }

    return;
}

sub needs_keystore {
    my $self = shift;

    return any { $self->{type} eq $_ } qw(keyid userid);
}

sub set {
    my ($self, $type, $handle) = @_;

    $self->{type} = $type;
    $self->{handle} = $handle;

    $self->_sanitize();
}

sub type {
    my $self = shift;

    return $self->{type};
}

sub handle {
    my $self = shift;

    return $self->{handle};
}

=head1 CHANGES

=head2 Version 0.xx

This is a private module.

=cut

1;