Viewing file:  ApiKeyHeaderCredentials.php (3.71 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2024 Google LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
namespace Google\ApiCore;
use Google\Auth\GetQuotaProjectInterface;
/**
* The ApiKeyHeaderCredentials object provides a wrapper around an API key.
*/
class ApiKeyHeaderCredentials implements HeaderCredentialsInterface, GetQuotaProjectInterface
{
private string $apiKey;
private ?string $quotaProject;
/**
* ApiKeyHeaderCredentials constructor.
* @param string $apiKey The API key to set in the header for the request
* @param string|null $quotaProject The quota project associated with the API key.
* @throws ValidationException
*/
public function __construct(string $apiKey, ?string $quotaProject = null)
{
if (empty($apiKey)) {
throw new ValidationException('API key cannot be empty');
}
$this->apiKey = $apiKey;
$this->quotaProject = $quotaProject;
}
/**
* @return string|null The quota project associated with the credentials.
*/
public function getQuotaProject(): ?string
{
return $this->quotaProject;
}
/**
* @param string|null $unusedAudience audiences are not supported for API keys.
*
* @return callable|null Callable function that returns the API key header.
*/
public function getAuthorizationHeaderCallback(?string $unusedAudience = null): ?callable
{
$apiKey = $this->apiKey;
// NOTE: changes to this function should be treated carefully and tested thoroughly. It will
// be passed into the gRPC c extension, and changes have the potential to trigger very
// difficult-to-diagnose segmentation faults.
return function () use ($apiKey) {
return ['x-goog-api-key' => [$apiKey]];
};
}
/**
* Verify that the expected universe domain matches the universe domain from the credentials.
*
* @throws ValidationException if the universe domain does not match.
*/
public function checkUniverseDomain(): void
{
// This is a no-op, as API keys are not tied to a universe domain. As a result, the
// potential for leaking API keys to the GDU is higher, and it's recommended to specify
// the "universeDomain" option with the GAPIC client.
}
}
|