/usr/lib/perl5/Sys/Virt/Secret.pm is in libsys-virt-perl 1.2.1-1.
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 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 | # -*- perl -*-
#
# Copyright (C) 2006 Red Hat
# Copyright (C) 2006-2007 Daniel P. Berrange
#
# This program is free software; You can redistribute it and/or modify
# it under either:
#
# a) the GNU General Public License as published by the Free
# Software Foundation; either version 2, or (at your option) any
# later version,
#
# or
#
# b) the "Artistic License"
#
# The file "LICENSE" distributed along with this file provides full
# details of the terms and conditions of the two licenses.
=pod
=head1 NAME
Sys::Virt::Secret - Represent & manage a libvirt secret
=head1 DESCRIPTION
The C<Sys::Virt::Secret> module represents a secret managed
by the virtual machine monitor.
=head1 METHODS
=over 4
=cut
package Sys::Virt::Secret;
use strict;
use warnings;
sub _new {
my $proto = shift;
my $class = ref($proto) || $proto;
my %params = @_;
my $con = exists $params{connection} ? $params{connection} : die "connection parameter is requried";
my $self;
if (exists $params{usageID} ||
exists $params{usageType}) {
die "usageID parameter must be provided with usageType" unless exists $params{usageID};
die "usageType parameter must be provided with usageID" unless exists $params{usageType};
$self = Sys::Virt::Secret::_lookup_by_usage($con, $params{usageType}, $params{usageID});
} elsif (exists $params{uuid}) {
if (length($params{uuid}) == 16) {
$self = Sys::Virt::Secret::_lookup_by_uuid($con, $params{uuid});
} elsif (length($params{uuid}) == 32 ||
length($params{uuid}) == 36) {
$self = Sys::Virt::Secret::_lookup_by_uuid_string($con, $params{uuid});
} else {
die "UUID must be either 16 unsigned bytes, or 32/36 hex characters long";
}
} elsif (exists $params{xml}) {
$self = Sys::Virt::Secret::_define_xml($con, $params{xml});
} else {
die "usageID, xml or uuid parameters are required";
}
bless $self, $class;
return $self;
}
=item my $uuid = $sec->get_uuid()
Returns a 16 byte long string containing the raw globally unique identifier
(UUID) for the secret.
=item my $uuid = $sec->get_uuid_string()
Returns a printable string representation of the raw UUID, in the format
'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'.
=item my $type = $sec->get_usage_type()
Returns the usage type of this secret. The usage type determines the
format of the unique identifier for this secret.
=item my $id = $sec->get_usage_id()
Returns the identifier of the object with which the secret is to
be used. For secrets with a usage type of volume, the identifier
is the fully qualfied path.
=item my $xml = $sec->get_xml_description()
Returns an XML document containing a complete description of
the secret's configuration
=item $sec->undefine()
Remove the configuration associated with a secret previously defined
with the C<define_secret> method in L<Sys::Virt>.
=item $bytes = $sec->get_value()
Returns the raw bytes for the value of this secret, or undef if
there is no value stored with the secret.
=item $sec->set_value($bytes)
Sets the value for the secret to be C<$bytes>.
=back
=head1 CONSTANTS
This section documents constants that are used with various
APIs described above
=head2 SECRET USAGE TYPE
The following constants refer to the different usage types
=over 4
=item Sys::Virt::Secret::USAGE_TYPE_NONE
The constant for secrets which are not assigned for use with a
particular object
=item Sys::Virt::Secret::USAGE_TYPE_VOLUME
The constant for secrets which are to be used for storage
volume encryption. The usage ID for secrets will refer to
the fully qualified volume path.
=item Sys::Virt::Secret::USAGE_TYPE_CEPH
The constant for secrets which are to be used for authenticating
to CEPH storage volumes. The usage ID for secrets will refer to
the server name.
=item Sys::Virt::Secret::USAGE_TYPE_ISCSI
The constant for secrets which are to be used for authenticating
to iSCSI storage volumes. The usage ID for secrets will refer to
the server name.
=back
=head2 LIST FILTERING
The following constants are used to filter object lists
=over 4
=item Sys::Virt::Secret::LIST_EPHEMERAL
Include any secrets marked as ephemeral
=item Sys::Virt::Secret::LIST_NO_EPHEMERAL
Include any secrets not marked as ephemeral
=item Sys::Virt::Secret::LIST_PRIVATE
Include any secrets marked as private
=item Sys::Virt::Secret::LIST_NO_PRIVATE
Include any secrets not marked as private
=back
=cut
1;
=head1 AUTHORS
Daniel P. Berrange <berrange@redhat.com>
=head1 COPYRIGHT
Copyright (C) 2006-2009 Red Hat
Copyright (C) 2006-2007 Daniel P. Berrange
=head1 LICENSE
This program is free software; you can redistribute it and/or modify
it under the terms of either 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), or, the Artistic License, as specified
in the Perl README file.
=head1 SEE ALSO
L<Sys::Virt>, L<Sys::Virt::Error>, C<http://libvirt.org>
=cut
|