pculka/aws4-auth-bundle

Allows HTTP requests to check for AWS4 signature

dev-master 2016-04-21 11:00 UTC

Requires

• php: >=5.5.0
• aws/aws-sdk-php: ^3.17
• symfony/framework-bundle: ^3.0

Requires (Dev)

• doctrine/doctrine-bundle: ~1.0
• doctrine/orm: ^2.5
• jms/serializer-bundle: ~0.11|~1.0
• phpunit/phpunit: ~4.0
• symfony/form: ~2.3|~3.0
• symfony/security: ~2.1|~3.0
• symfony/security-bundle: ~2.1|~3.0
• symfony/security-http: ~2.1|~3.0
• symfony/templating: ~2.1|~3.0
• symfony/twig-bundle: ~2.1|~3.0
• symfony/validator: ~2.1|~3.0

MIT

• http
• amazon
• bundle
• aws4

README

Installation

Installation is a quick 5 steps process:

1. Download AWS4AuthBundle
2. Enable the Bundle in your Kernel
3. Extend your model class
4. Configure your application's security.yml
5. Configure the AWS4AuthBundle

Step 1: Install AWS4AuthBundle

The preferred way to install this bundle is via Composer. Check on Packagist the version you want to install and add it to your composer.json:

{
    "require": {
        // ...
        "pculka/aws4-auth-bundle": "dev-master"
    }
}

Step 2: Enable the Bundle in your Kernel

To enable the bundle in the kernel, just add it to your registerBundles() function:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new PC\Aws4AuthBundle\PCAws4AuthBundle(),
    );
}

Step 3: Extend your model class

Step 4: Configure your application's security.yml

The bundle provides a security layer. This layer works as a sole authentication provider and cannot be chained!

Creation of a chainable interface is still to be done and is planned for a future release.

security:
    firewalls:
        aws4fw:
            pattern: ^/amazon-like-api/
            stateless: true
            aws4auth: true

Step 5: Configure the AWS4AuthBundle

# app/config/config.yml

pc_aws4_auth:
    user_class: \Acme\Bundle\Entity\User