Metadata-Version: 1.1
Name: aws-acl-helper
Version: 0.1.2
Summary: Squid external ACL helper that allows use of AWS instance metadata
Home-page: https://github.com/brandond/aws-acl-helper
Author: Brandon Davidson
Author-email: brad@oatmail.org
License:    Copyright 2016 Brandon Davidson

   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.

Download-URL: https://github.com/brandond/aws-acl-helper/tarball/0.1.2
Description: AWS ACL Helper
        ==============
        
        This module implements the Squid External ACL Helper interface, and
        allows for use of EC2 instance metadata in ACL entries. It uses the
        client's source address (either public or private) as a key to determine
        which instance initiated a request through the proxy, and allows use of
        instance metadata (such as Instance ID, VPC, or Security Group
        membership) as a rule target.
        
        If the request can be mapped to an EC2 instance, the module will
        populate the EC2 Instance ID into the request's 'user' field, for
        consumption by additional ACLs or output to logs. This occurs regardless
        of whether or not the ACL matched.
        
        Prerequisites
        -------------
        
        This module requires Python 3.4 or better, due to its use of the
        ``asyncio`` framework (``aioredis``, etc)
        
        This module requires a Redis server to cache AWS instance metadata.
        Redis clusters are not currently supported; use of a local Redis
        instance is recommended.
        
        This module uses Boto3 to retrieve EC2 instance metadata from AWS. You
        should have a working AWS API environment (~/.aws/credentials,
        environment variables, or EC2 IAM Role) that allows calling EC2's
        ``describe-instances`` method against the account that Squid is running
        in. 
        
        Consult `README.md on GitHub <https://github.com/brandond/aws-acl-helper/blob/master/README.md>`__ for usage instructions.
        
Platform: UNKNOWN
