akamai / akamaiopen-edgegrid-php Goto Github PK

View Code? Open in Web Editor NEW

14.0 10.0 14.0 634 KB

PHP library for Akamai {OPEN} EdgeGrid Authentication scheme (signing only)

Home Page: https://techdocs.akamai.com/home

License: Apache License 2.0

PHP 98.10% Shell 1.90%

edgegrid php akamai signer auth authorization open authentication akamai-devexp

akamaiopen-edgegrid-php's Introduction

akamai-open/edgegrid-auth

Akamai EdgeGrid Authentication for PHP

This library requires PHP 8+ and implements the Akamai EdgeGrid Authentication scheme for PHP.

Install

To install, use composer:

$ composer require akamai-open/edgegrid-auth

Alternative installation methods

Single file (PHAR)

Download the PHAR file from the releases page and include it inside your code:

```php
include 'akamai-open-edgegrid-auth.phar';

// Library is ready to use
```

Clone or download

Either clone or download to pull down a copy of this repository.
- Clone the repository using git or subversion.
- Download the latest ZIP archive or specific release ZIP archive.
Use the composer autoloader and install the dependencies.
```
  $ composer install
```

Include the autoloader.

require_once 'vendor/autoload.php';

If you don't use the autoloader, include all the required classes manually in your code.

require_once 'src/Authentication.php';
require_once 'src/Authentication/Timestamp.php';
require_once 'src/Authentication/Nonce.php';
require_once 'src/Authentication/Exception.php';
require_once 'src/Authentication/Exception/ConfigException.php';
require_once 'src/Authentication/Exception/SignerException.php';
require_once 'src/Authentication/Exception/SignerException/InvalidSignDataException.php';

Use

Once you have installed the library, you can create the header value by calling the appropriate \Akamai\Open\Edgegrid\Authentication::set*() methods.

For example, using it with the built-in streams HTTP client might look like the following:

$auth = \Akamai\Open\EdgeGrid\Authentication::createFromEdgeRcFile('default', '/.edgerc');
$auth->setHttpMethod('GET');
$auth->setPath('/identity-management/v3/user-profile');

$context = array(
  'http' => array(
    'header' => array(
      'Authorization: ' . $auth->createAuthHeader(),
      'Content-Type: application/json'
    )
  )
);

$context = stream_context_create($context);

$response = json_decode(file_get_contents('https://' . $auth->getHost() . $auth->getPath(), null, $context));

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

akamaiopen-edgegrid-php's People

Contributors

Stargazers

Watchers

Forkers

remicollet siwinski vasuvall gfirem konstadinapap marsalans keyur-sakaria-netcore sharayuyadav plutonianbe shamakhan isabella232 francemediasmonde skearney-akamai silverstripe-terraformers

akamaiopen-edgegrid-php's Issues

Deprecated warning GuzzleHttp\Client class is considered final

Using php 8.1 we have the following deprecated warning :

User Deprecated: The "GuzzleHttp\Client" class is considered final. It may change without further notice as of its next major version. You should not extend it from "Akamai\Open\EdgeGrid\Client". {"exception":"[object] (ErrorException(code: 0): User Deprecated: The "GuzzleHttp\Client" class is considered final. It may change without further notice as of its next major version. You should not extend it from "Akamai\Open\EdgeGrid\Client". at /var/www/enrj-importer-php/vendor/symfony/error-handler/DebugClassLoader.php:333)"} []

Library doesn't ignore trailing whitespace on credentials

If the .edgerc has trailing whitespace on any of it's values, the library does not trim them, resulting in an invalid signature.

Question: Release a version with PHP 7.4 support?

Hey maintainers,

I am currently struggling with updating

akamai-open/edgegrid-client
akamai-open/edgegrid-auth

to v2, as it requires PHP 8.1, however, there is no PHP 7.4-compatible version with guzzle 7 in place, which I need as an intermediate step before our hosting provider is able to update to PHP 8.1.

As I noticed in the source code of this repo, it is possible to reduce the PHP version constraint in composer.json to use "^7.4 || ^8.1" without any further effort. This way, a new release is able for people to update their public packages with a better version constraint. After having a 7.4 compatible v2 release (2.0.1), we could then raise again to PHP 8.1+ again.

My question is this: Would you be willing for such a move, or should I create an official fork?

Another official alternative for me is to try to require Guzzle v7 in your akamai-open/edgegrid-* v1.x versions (in case this is still maintained).

Thanks for your feedback in advance!

Seeing dependency conflict in our application with monolog 1.x, any plans to use/support 2.x?

The Drupal Akamai module depends on edgegrid, which in turn depends on monolog 1.x.

Drupal also has a module for using monolog as it's primary log routing mechanism, and it depends on 2.x

We can do some potential ninja-fu to work around this, but given that the project has marked 1.x as "maint only" I wonder if it's worth looking at bumping the dep

Deprecated function: http_build_query()

Deprecated function: http_build_query(): Passing null to parameter #2 ($numeric_prefix) of type string is deprecated in Akamai\Open\EdgeGrid\Authentication->buildQueryString()

Seeing this warning thrown in logs.

Tests fail on PHP 7.1

$ php71 vendor/bin/phpunit
PHPUnit 4.8.27 by Sebastian Bergmann and contributors.

Runtime:	PHP 7.1.0RC6
Configuration:	/home/siwinski/projects/AkamaiOPEN-edgegrid-php/phpunit.xml.dist
Warning:	The Xdebug extension is not loaded
		No code coverage will be generated.

..F.........................................

Time: 2.04 seconds, Memory: 6.00MB

There was 1 failure:

1) Akamai\Open\EdgeGrid\Tests\Client\Authentication\TimestampTest::testTimestampFormat
Failed asserting that two DateTime objects are equal.
--- Expected
+++ Actual
@@ @@
 2016-12-09T00:07:14+0000

/home/siwinski/projects/AkamaiOPEN-edgegrid-php/tests/Authentication/TimestampTest.php:32

FAILURES!
Tests: 44, Assertions: 114, Failures: 1.

I was going to submit the following diff/patch but I don't know if it defeats the purpose of that test:

29a30
>         $actual = \PHPUnit_Framework_Assert::readAttribute($timestamp, 'timestamp');
31,32c32,34
<         $check = \DateTime::createFromFormat('Ymd\TH:i:sO', (string) $timestamp, new \DateTimeZone('UTC'));
<         $this->assertEquals($check, \PHPUnit_Framework_Assert::readAttribute($timestamp, 'timestamp'));
---
>         $expected = \DateTime::createFromFormat('Ymd\TH:i:sO', (string) $timestamp, new \DateTimeZone('UTC'));
> 
>         $this->assertEquals($expected->format('Y-m-d H:i:s'), $actual->format('Y-m-d H:i:s'));