SignatureInterface.php 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?php
  2. /**
  3. * Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License").
  6. * You may not use this file except in compliance with the License.
  7. * A copy of the License is located at
  8. *
  9. * http://aws.amazon.com/apache2.0
  10. *
  11. * or in the "license" file accompanying this file. This file is distributed
  12. * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  13. * express or implied. See the License for the specific language governing
  14. * permissions and limitations under the License.
  15. */
  16. namespace Aws\Common\Signature;
  17. use Aws\Common\Credentials\CredentialsInterface;
  18. use Guzzle\Http\Message\RequestInterface;
  19. /**
  20. * Interface used to provide interchangeable strategies for signing requests
  21. * using the various AWS signature protocols.
  22. */
  23. interface SignatureInterface
  24. {
  25. /**
  26. * Signs the specified request with an AWS signing protocol by using the
  27. * provided AWS account credentials and adding the required headers to the
  28. * request.
  29. *
  30. * @param RequestInterface $request Request to add a signature to
  31. * @param CredentialsInterface $credentials Signing credentials
  32. */
  33. public function signRequest(RequestInterface $request, CredentialsInterface $credentials);
  34. }