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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
|
package Net::Amazon::S3::HTTPRequest;
use Moose 0.85;
use MooseX::StrictConstructor 0.16;
use HTTP::Date;
use MIME::Base64 qw( encode_base64 );
use Moose::Util::TypeConstraints;
use URI::Escape qw( uri_escape_utf8 );
use URI::QueryParam;
my $METADATA_PREFIX = 'x-amz-meta-';
my $AMAZON_HEADER_PREFIX = 'x-amz-';
enum 'HTTPMethod' => qw(DELETE GET HEAD PUT);
has 's3' => ( is => 'ro', isa => 'Net::Amazon::S3', required => 1 );
has 'method' => ( is => 'ro', isa => 'HTTPMethod', required => 1 );
has 'path' => ( is => 'ro', isa => 'Str', required => 1 );
has 'headers' =>
( is => 'ro', isa => 'HashRef', required => 0, default => sub { {} } );
has 'content' =>
( is => 'ro', isa => 'Str|CodeRef', required => 0, default => '' );
has 'metadata' =>
( is => 'ro', isa => 'HashRef', required => 0, default => sub { {} } );
__PACKAGE__->meta->make_immutable;
# make the HTTP::Request object
sub http_request {
my $self = shift;
my $method = $self->method;
my $path = $self->path;
my $headers = $self->headers;
my $content = $self->content;
my $metadata = $self->metadata;
my $http_headers = $self->_merge_meta( $headers, $metadata );
$self->_add_auth_header( $http_headers, $method, $path )
unless exists $headers->{Authorization};
my $protocol = $self->s3->secure ? 'https' : 'http';
my $uri = "$protocol://s3.amazonaws.com/$path";
if ( $path =~ m{^([^/?]+)(.*)} && _is_dns_bucket($1) ) {
$uri = "$protocol://$1.s3.amazonaws.com$2";
}
my $request
= HTTP::Request->new( $method, $uri, $http_headers, $content );
# my $req_as = $request->as_string;
# $req_as =~ s/[^\n\r\x20-\x7f]/?/g;
# $req_as = substr( $req_as, 0, 1024 ) . "\n\n";
# warn $req_as;
return $request;
}
sub query_string_authentication_uri {
my ( $self, $expires ) = @_;
my $method = $self->method;
my $path = $self->path;
my $headers = $self->headers;
my $aws_access_key_id = $self->s3->aws_access_key_id;
my $aws_secret_access_key = $self->s3->aws_secret_access_key;
my $canonical_string
= $self->_canonical_string( $method, $path, $headers, $expires );
my $encoded_canonical
= $self->_encode( $aws_secret_access_key, $canonical_string );
my $protocol = $self->s3->secure ? 'https' : 'http';
my $uri = "$protocol://s3.amazonaws.com/$path";
if ( $path =~ m{^([^/?]+)(.*)} && _is_dns_bucket($1) ) {
$uri = "$protocol://$1.s3.amazonaws.com$2";
}
$uri = URI->new($uri);
$uri->query_param( AWSAccessKeyId => $aws_access_key_id );
$uri->query_param( Expires => $expires );
$uri->query_param( Signature => $encoded_canonical );
return $uri;
}
sub _add_auth_header {
my ( $self, $headers, $method, $path ) = @_;
my $aws_access_key_id = $self->s3->aws_access_key_id;
my $aws_secret_access_key = $self->s3->aws_secret_access_key;
if ( not $headers->header('Date') ) {
$headers->header( Date => time2str(time) );
}
my $canonical_string
= $self->_canonical_string( $method, $path, $headers );
my $encoded_canonical
= $self->_encode( $aws_secret_access_key, $canonical_string );
$headers->header(
Authorization => "AWS $aws_access_key_id:$encoded_canonical" );
}
# generate a canonical string for the given parameters. expires is optional and is
# only used by query string authentication.
sub _canonical_string {
my ( $self, $method, $path, $headers, $expires ) = @_;
my %interesting_headers = ();
while ( my ( $key, $value ) = each %$headers ) {
my $lk = lc $key;
if ( $lk eq 'content-md5'
or $lk eq 'content-type'
or $lk eq 'date'
or $lk =~ /^$AMAZON_HEADER_PREFIX/ )
{
$interesting_headers{$lk} = $self->_trim($value);
}
}
# these keys get empty strings if they don't exist
$interesting_headers{'content-type'} ||= '';
$interesting_headers{'content-md5'} ||= '';
# just in case someone used this. it's not necessary in this lib.
$interesting_headers{'date'} = ''
if $interesting_headers{'x-amz-date'};
# if you're using expires for query string auth, then it trumps date
# (and x-amz-date)
$interesting_headers{'date'} = $expires if $expires;
my $buf = "$method\n";
foreach my $key ( sort keys %interesting_headers ) {
if ( $key =~ /^$AMAZON_HEADER_PREFIX/ ) {
$buf .= "$key:$interesting_headers{$key}\n";
} else {
$buf .= "$interesting_headers{$key}\n";
}
}
# don't include anything after the first ? in the resource...
$path =~ /^([^?]*)/;
$buf .= "/$1";
# ...unless there is an acl or torrent parameter
if ( $path =~ /[&?]acl($|=|&)/ ) {
$buf .= '?acl';
} elsif ( $path =~ /[&?]torrent($|=|&)/ ) {
$buf .= '?torrent';
} elsif ( $path =~ /[&?]location($|=|&)/ ) {
$buf .= '?location';
}
return $buf;
}
# finds the hmac-sha1 hash of the canonical string and the aws secret access key and then
# base64 encodes the result (optionally urlencoding after that).
sub _encode {
my ( $self, $aws_secret_access_key, $str, $urlencode ) = @_;
my $hmac = Digest::HMAC_SHA1->new($aws_secret_access_key);
$hmac->add($str);
my $b64 = encode_base64( $hmac->digest, '' );
if ($urlencode) {
return $self->_urlencode($b64);
} else {
return $b64;
}
}
# EU buckets must be accessed via their DNS name. This routine figures out if
# a given bucket name can be safely used as a DNS name.
sub _is_dns_bucket {
my $bucketname = $_[0];
if ( length $bucketname > 63 ) {
return 0;
}
if ( length $bucketname < 3 ) {
return;
}
return 0 unless $bucketname =~ m{^[a-z0-9][a-z0-9.-]+$};
my @components = split /\./, $bucketname;
for my $c (@components) {
return 0 if $c =~ m{^-};
return 0 if $c =~ m{-$};
return 0 if $c eq '';
}
return 1;
}
# generates an HTTP::Headers objects given one hash that represents http
# headers to set and another hash that represents an object's metadata.
sub _merge_meta {
my ( $self, $headers, $metadata ) = @_;
$headers ||= {};
$metadata ||= {};
my $http_header = HTTP::Headers->new;
while ( my ( $k, $v ) = each %$headers ) {
$http_header->header( $k => $v );
}
while ( my ( $k, $v ) = each %$metadata ) {
$http_header->header( "$METADATA_PREFIX$k" => $v );
}
return $http_header;
}
sub _trim {
my ( $self, $value ) = @_;
$value =~ s/^\s+//;
$value =~ s/\s+$//;
return $value;
}
sub _urlencode {
my ( $self, $unencoded ) = @_;
return uri_escape_utf8( $unencoded, '^A-Za-z0-9_-' );
}
1;
__END__
=head1 NAME
Net::Amazon::S3::HTTPRequest - Create a signed HTTP::Request
=head1 SYNOPSIS
my $http_request = Net::Amazon::S3::HTTPRequest->new(
s3 => $self->s3,
method => 'PUT',
path => $self->bucket . '/',
headers => $headers,
content => $content,
)->http_request;
=head1 DESCRIPTION
This module creates an HTTP::Request object that is signed
appropriately for Amazon S3.
=head1 METHODS
=head2 http_request
This method creates, signs and returns a HTTP::Request object.
=head2 query_string_authentication_uri
This method creates, signs and returns a query string authentication
URI.
|