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
|
# Wallet::Object::Duo::PAM -- Duo PAM int. object implementation for wallet
#
# Written by Russ Allbery <eagle@eyrie.org>
# Jon Robertson <jonrober@stanford.edu>
# Copyright 2014
# The Board of Trustees of the Leland Stanford Junior University
#
# See LICENSE for licensing terms.
##############################################################################
# Modules and declarations
##############################################################################
package Wallet::Object::Duo::PAM;
require 5.006;
use strict;
use warnings;
use vars qw(@ISA $VERSION);
use JSON;
use Net::Duo::Admin;
use Net::Duo::Admin::Integration;
use Perl6::Slurp qw(slurp);
use Wallet::Config ();
use Wallet::Object::Duo;
@ISA = qw(Wallet::Object::Duo);
# This version should be increased on any code change to this module. Always
# use two digits for the minor version with a leading zero if necessary so
# that it will sort properly.
$VERSION = '0.01';
##############################################################################
# Core methods
##############################################################################
# Override create to provide the specific Duo integration type that will be
# used in the remote Duo record.
sub create {
my ($class, $type, $name, $schema, $creator, $host, $time) = @_;
$time ||= time;
my $self = $class->SUPER::create ($type, $name, $schema, $creator, $host,
$time, 'unix');
return $self;
}
# Override get to output the data in a specific format used by Duo's PAM
# module.
sub get {
my ($self, $user, $host, $time) = @_;
$time ||= time;
# Check that the object isn't locked.
my $id = $self->{type} . ':' . $self->{name};
if ($self->flag_check ('locked')) {
$self->error ("cannot get $id: object is locked");
return;
}
# Retrieve the integration from Duo.
my $key;
eval {
my %search = (du_name => $self->{name});
my $row = $self->{schema}->resultset ('Duo')->find (\%search);
$key = $row->get_column ('du_key');
};
if ($@) {
$self->error ($@);
return;
}
my $integration = Net::Duo::Admin::Integration->new ($self->{duo}, $key);
# We also need the admin server name, which we can get from the Duo object
# configuration with a bit of JSON decoding.
my $json = JSON->new->utf8 (1)->relaxed (1);
my $config = $json->decode (scalar slurp $Wallet::Config::DUO_KEY_FILE);
# Construct the returned file.
my $output = "[duo]\n";
$output .= "ikey = $key\n";
$output .= 'skey = ' . $integration->secret_key . "\n";
$output .= "host = $config->{api_hostname}\n";
# Log the action and return.
$self->log_action ('get', $user, $host, $time);
return $output;
}
1;
__END__
##############################################################################
# Documentation
##############################################################################
=for stopwords
Allbery Duo integration DBH keytab
=head1 NAME
Wallet::Object::Duo::PAM -- Duo PAM int. object implementation for wallet
=head1 SYNOPSIS
my @name = qw(duo-pam host.example.com);
my @trace = ($user, $host, time);
my $object = Wallet::Object::Duo::PAM->create (@name, $schema, @trace);
my $config = $object->get (@trace);
$object->destroy (@trace);
=head1 DESCRIPTION
Wallet::Object::Duo::PAM is a representation of Duo integrations with
the wallet, specifically to output Duo integrations in a format that
can easily be pulled into configuring the Duo PAM interface. It
implements the wallet object API and provides the necessary glue to
create a Duo integration, return a configuration file containing the key
and API information for that integration, and delete the integration from
Duo when the wallet object is destroyed.
The integration information is always returned in the configuration file
format expected by the Duo UNIX integration. The results of retrieving
this object will be text, suitable for putting in the UNIX integration
configuration file, containing the integration key, secret key, and admin
hostname for that integration.
This object can be retrieved repeatedly without changing the secret key,
matching Duo's native behavior with integrations. To change the keys of
the integration, delete it and recreate it.
To use this object, at least one configuration parameter must be set. See
L<Wallet::Config> for details on supported configuration parameters and
information about how to set wallet configuration.
=head1 METHODS
This object mostly inherits from Wallet::Object::Duo. See the
documentation for that class for all generic methods. Below are only
those methods that are overridden or behave specially for this
implementation.
=over 4
=item create(TYPE, NAME, DBH, PRINCIPAL, HOSTNAME [, DATETIME])
This will override the Wallet::Object::Duo class with the information
needed to create a specific integration type in Duo. It creates a new
object with the given TYPE and NAME (TYPE is normally C<duo-pam> and must
be for the rest of the wallet system to use the right class, but this
module doesn't check for ease of subclassing), using DBH as the handle
to the wallet metadata database. PRINCIPAL, HOSTNAME, and DATETIME are
stored as history information. PRINCIPAL should be the user who is
creating the object. If DATETIME isn't given, the current time is
used.
When a new Duo integration object is created, a new integration will be
created in the configured Duo account and the integration key will be
stored in the wallet object. If the integration already exists, create()
will fail.
If create() fails, it throws an exception.
=item get(PRINCIPAL, HOSTNAME [, DATETIME])
Retrieves the configuration information for the Duo integration and
returns that information in the format expected by the configuration file
for the Duo UNIX integration. Returns undef on failure. The caller
should call error() to get the error message if get() returns undef.
The returned configuration look look like:
[duo]
ikey = <integration-key>
skey = <secret-key>
host = <api-hostname>
The C<host> parameter will be taken from the configuration file pointed
to by the DUO_KEY_FILE configuration variable.
PRINCIPAL, HOSTNAME, and DATETIME are stored as history information.
PRINCIPAL should be the user who is downloading the keytab. If DATETIME
isn't given, the current time is used.
=back
=head1 LIMITATIONS
Only one Duo account is supported for a given wallet implementation.
=head1 SEE ALSO
Net::Duo(3), Wallet::Config(3), Wallet::Object::Duo(3), wallet-backend(8)
This module is part of the wallet system. The current version is
available from L<http://www.eyrie.org/~eagle/software/wallet/>.
=head1 AUTHORS
Russ Allbery <eagle@eyrie.org>
Jon Robertson <eagle@eyrie.org>
=cut
|
