API Documentation

Service/Amazon/Authentication/V1.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service_Amazon  
subpackage
Authentication  

\Zend_Service_Amazon_Authentication_V1

Extends from
\Zend_Service_Amazon_Authentication
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service_Amazon  
subpackage
Authentication  

Properties

Propertyprotected  $_signatureMethod= 'HmacSHA256'

Signature Encoding Method

Default valueHmacSHA256Details
Type
Propertyprotected  $_signatureVersion= '1'

Signature Version

Default value1Details
Type

Methods

methodpublic__construct( string $accessKey, string $secretKey, string $apiVersion ) : void
Parameters
Name Type Description
$accessKey string
$secretKey string
$apiVersion string
methodprotected_signParameters(  $url,  $paramaters ) : string

Computes the RFC 2104-compliant HMAC signature for request parameters

This implements the Amazon Web Services signature, as per the following specification:

  1. Sort all request parameters (including SignatureVersion and excluding Signature, the value of which is being created), ignoring case.

  2. Iterate over the sorted list and append the parameter name (in its original case) and then its value. Do not URL-encode the parameter values before constructing this string. Do not use any separator characters when appending strings.

Parameters
Name Type Description
$url
$paramaters
Returns
Type Description
string the signed data.
methodpublicgenerateSignature( string $url, array $parameters ) : string

Generate the required attributes for the signature

Parameters
Name Type Description
$url string
$parameters array
Returns
Type Description
string
methodpublicsetAccessKey( string $accessKey ) : void
Parameters
Name Type Description
$accessKey string
methodpublicsetApiVersion( string $apiVersion ) : void
Parameters
Name Type Description
$apiVersion string
methodpublicsetSecretKey( string $secretKey ) : void
Parameters
Name Type Description
$secretKey string
Documentation was generated by DocBlox 0.13.3.