PreSign request (#341)

* Draft PreSign request

* Add documentation

* Implement Presign in Signers

* Regenerate Inputs

* Refactor signer

* Fix compare aligment

* Add RequestContext

* Add SDK tests

* Typehint with DatetimeInterface

* Remove presign override in s3

* Use memory first for RewindableFallback

* Add comment on internal use of RewindableStream

* Close stream and fix typehint

* Fix treshold size

Author: jderusse

src/AbstractApi.php

@@ -80,17 +80,31 @@ final public function getConfiguration(): Configuration
         return $this->configuration;
     }
 
+    final public function presign(Input $input, ?\DateTimeInterface $expires = null): string
+    {
+        $request = $input->request();
+        $request->setEndpoint($this->getEndpoint($request->getUri(), $request->getQuery()));
+
+        if (null !== $credentials = $this->credentialProvider->getCredentials($this->configuration)) {
+            $this->getSigner()->presign($request, $credentials, new RequestContext(['expirationDate' => $expires]));
+        }
+
+        return $request->getEndpoint();
+    }
+
     abstract protected function getServiceCode(): string;
 
     abstract protected function getSignatureVersion(): string;
 
     abstract protected function getSignatureScopeName(): string;
 
-    final protected function getResponse(Request $request): Response
+    final protected function getResponse(Request $request, ?RequestContext $context = null): Response
     {
         $request->setEndpoint($this->getEndpoint($request->getUri(), $request->getQuery()));
 
-        $this->getSigner()->sign($request, $this->credentialProvider->getCredentials($this->configuration));
+        if (null !== $credentials = $this->credentialProvider->getCredentials($this->configuration)) {
+            $this->getSigner()->sign($request, $credentials, $context ?? new RequestContext());
+        }
 
         $length = $request->getBody()->length();
         if (null !== $length && !$request->hasHeader('content-length')) {

src/Input.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace AsyncAws\Core;
+
+/**
+ * Representation of a AWS Request.
+ *
+ * @author Jérémy Derussé <[email protected]>
+ *
+ * @internal
+ */
+interface Input
+{
+    public function request(): Request;
+}

src/Request.php

@@ -6,7 +6,7 @@
 use AsyncAws\Core\Stream\Stream;
 
 /**
- * Representation of a AWS Request.
+ * Representation of an HTTP Request.
  *
  * @author Jérémy Derussé <[email protected]>
  *
@@ -26,6 +26,8 @@ class Request
 
     private $endpoint;
 
+    private $parsed;
+
     /**
      * @param string[]|string[][] $headers
      */
@@ -47,6 +49,11 @@ public function getMethod(): string
         return $this->method;
     }
 
+    public function setMethod(string $method): void
+    {
+        $this->method = $method;
+    }
+
     public function getUri(): string
     {
         return $this->uri;
@@ -75,6 +82,11 @@ public function getHeader(string $name)
         return $this->headers[strtolower($name)] ?? null;
     }
 
+    public function removeHeader(string $name): void
+    {
+        unset($this->headers[strtolower($name)]);
+    }
+
     public function getBody(): Stream
     {
         return $this->body;
@@ -85,13 +97,39 @@ public function setBody(Stream $body)
         $this->body = $body;
     }
 
+    public function hasQueryAttribute($name): bool
+    {
+        return \array_key_exists($name, $this->query);
+    }
+
+    public function removeQueryAttribute($name): void
+    {
+        unset($this->query[$name]);
+        $this->endpoint = '';
+    }
+
+    public function setQueryAttribute($name, $value): void
+    {
+        $this->query[$name] = $value;
+        $this->endpoint = '';
+    }
+
+    public function getQueryAttribute(string $name): ?string
+    {
+        return $this->query[$name] ?? null;
+    }
+
     public function getQuery(): array
     {
         return $this->query;
     }
 
     public function getEndpoint(): string
     {
+        if (empty($this->endpoint)) {
+            $this->endpoint = $this->parsed['scheme'] . '://' . $this->parsed['host'] . (isset($this->parsed['port']) ? ':' . $this->parsed['port'] : '') . $this->uri . ($this->query ? (false === \strpos($this->uri, '?') ? '?' : '&') . http_build_query($this->query) : '');
+        }
+
         return $this->endpoint;
     }
 
@@ -100,6 +138,10 @@ public function setEndpoint(string $endpoint): void
         if (!empty($this->endpoint)) {
             throw new LogicException('Request::$endpoint cannot be changed after it has a value.');
         }
+
         $this->endpoint = $endpoint;
+        $this->parsed = \parse_url($this->endpoint);
+        \parse_str($this->parsed['query'] ?? '', $this->query);
+        $this->uri = $this->parsed['path'] ?? '/';
     }
 }

src/RequestContext.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace AsyncAws\Core;
+
+use AsyncAws\Core\Exception\InvalidArgument;
+
+/**
+ * Contains contextual information alongside a request.
+ *
+ * @author Jérémy Derussé <[email protected]>
+ *
+ * @internal
+ */
+class RequestContext
+{
+    public const AVAILABLE_OPTIONS = [
+        'operation' => true,
+        'expirationDate' => true,
+        'currentDate' => true,
+    ];
+
+    /**
+     * @var string|null
+     */
+    private $operation;
+
+    /**
+     * @var \DateTimeInterface|null
+     */
+    private $expirationDate;
+
+    /**
+     * @var \DateTimeInterface|null
+     */
+    private $currentDate;
+
+    /**
+     * @param array{
+     *  operation?: null|string
+     *  expirationDate?: null|\\DateTimeInterface
+     *  currentDate?: null|\\DateTimeInterface
+     * }
+     */
+    public function __construct(array $options = [])
+    {
+        if (0 < \count($invalidOptions = \array_diff_key($options, self::AVAILABLE_OPTIONS))) {
+            throw new InvalidArgument(\sprintf('Invalid option(s) "%s" passed to "%s". ', \implode('", "', \array_keys($invalidOptions)), __METHOD__));
+        }
+
+        foreach ($options as $property => $value) {
+            $this->$property = $value;
+        }
+    }
+
+    public function getOperation(): ?string
+    {
+        return $this->operation;
+    }
+
+    public function getExpirationDate(): ?\DateTimeInterface
+    {
+        return $this->expirationDate;
+    }
+
+    public function getCurrentDate(): ?\DateTimeInterface
+    {
+        return $this->currentDate;
+    }
+}

src/Signer/Signer.php

@@ -4,6 +4,7 @@
 
 use AsyncAws\Core\Credentials\Credentials;
 use AsyncAws\Core\Request;
+use AsyncAws\Core\RequestContext;
 
 /**
  * Interface for signing a request.
@@ -12,5 +13,7 @@
  */
 interface Signer
 {
-    public function sign(Request $request, ?Credentials $credentials): void;
+    public function sign(Request $request, Credentials $credentials, RequestContext $context): void;
+
+    public function presign(Request $request, Credentials $credentials, RequestContext $context): void;
 }