/usr/lib/x86_64-linux-gnu/perl5/5.26/WebAuth/Key.pm is in libwebauth-perl 4.7.0-6build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # Documentation and supplemental methods for WebAuth keys.
#
# The primary implementation of the WebAuth::Key class is done in the WebAuth
# XS module since it's primarily implemented in C. This file adds some
# supplemental methods that are implemented in terms of other underlying calls
# and provides version and documentation information.
#
# Written by Russ Allbery <eagle@eyrie.org>
# Copyright 2012, 2013
# The Board of Trustees of the Leland Stanford Junior University
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
package WebAuth::Key;
require 5.006;
use strict;
use warnings;
use Carp qw(croak);
use WebAuth ();
our $VERSION;
# This version matches the version of WebAuth with which this module was
# released, but with two digits for the minor and patch versions.
BEGIN {
$VERSION = '4.0700';
}
# Constructor. Takes a WebAuth context, a key type, a key size, and optional
# key data and passes that off to WebAuth::key_create. Note that subclasses
# are not supported since the object is created by the XS module and will
# always be a WebAuth::Keyring.
sub new {
my ($class, $ctx, $type, $size, $data) = @_;
if ($class ne 'WebAuth::Key') {
croak ('subclassing of WebAuth::Key is not supported');
}
unless (ref ($ctx) eq 'WebAuth') {
croak ('second argument must be a WebAuth object');
}
if (defined $data) {
return $ctx->key_create ($type, $size, $data);
} else {
return $ctx->key_create ($type, $size);
}
}
1;
__END__
=for stopwords
WebAuth keyring WEBAUTH Allbery
=head1 NAME
WebAuth::Key - WebAuth encryption and decryption key
=head1 SYNOPSIS
use WebAuth qw(WA_KEY_AES WA_AES_128);
use WebAuth::Key;
my $wa = WebAuth->new;
eval {
$key = WebAuth::Key->new ($wa, WA_KEY_AES, WA_AES_128);
...
};
if ($@) {
# handle exception
}
=head1 DESCRIPTION
A WebAuth::Key object represents a single WebAuth key, which can be used
for encryption or decryption. Keys are normally stored in
WebAuth::Keyring objects, and token encoding and decoding requires a
keyring rather than a key.
To convert a key to a keyring, see the WebAuth keyring_new() method or
C<< WebAuth::Keyring->new >>.
A WebAuth::Key object will be destroyed when the WebAuth context used to
create it is destroyed, and subsequent accesses to it may cause memory
access errors or other serious bugs. Be careful not to retain a copy of a
WebAuth::Key object after the WebAuth object that created it has been
destroyed.
=head1 CLASS METHODS
As with WebAuth module functions, failures are signaled by throwing
WebAuth::Exception rather than by return status.
=over 4
=item new (WEBAUTH, TYPE, SIZE[, KEY_MATERIAL])
Create a new WebAuth::Key object within the provided WebAuth context,
which must be a valid WebAuth object. TYPE currently must be WA_KEY_AES,
and SIZE must be one of WA_AES_128, WA_AES_192, or WA_AES_256. This may
change in the future if WebAuth gains support for additional key types.
If KEY_MATERIAL is given, it should contain SIZE bytes of data, which
will be used as the key. If KEY_MATERIAL is not given or is undef, a
new random key of the specified TYPE and SIZE will be generated.
This is a convenience wrapper around the WebAuth key_create() method.
=back
=head1 INSTANCE METHODS
=over 4
=item data ()
Returns the binary key data.
=item length ()
Returns the length of the key, which will currently be one of WA_AES_128,
WA_AES_192, or WA_AES_256. This is the length of the key in bytes.
=item type ()
Returns the type of the key, which currently will always be WA_KEY_AES.
=back
=head1 AUTHOR
Russ Allbery <eagle@eyrie.org>
=head1 SEE ALSO
WebAuth(3), WebAuth::Keyring(3)
This module is part of WebAuth. The current version is available from
L<http://webauth.stanford.edu/>.
=cut
|