Metadata-Version: 1.1
Name: ip2instance
Version: 1.2.2
Summary: Search through multiple AWS accounts for instance IP addresses
Home-page: https://github.com/gene1wood/ip2instance
Author: Gene Wood
Author-email: gene_wood@cementhorizon.com
License: MPL 2.0
Description: Overview
        ========
        
        ip2instance iterates through multiple AWS accounts, assuming IAM Roles in each
        account using the STS AssumeRole function and fetches information about
        instances in those accounts.
        
        Prerequisites
        =============
        
        * That ip2instance be run on an AWS ec2 instance with an IAM role which has
          rights to assume other roles
        * That the list of other roles in various foreign AWS accounts
           * have the permission to Describe instances
           * allow the role applied to the ec2 instance running ip2instance to assume
             the target role
        
        Instructions on setting up these roles can be found here : 
        https://github.com/mozilla/security/tree/master/operations/aws-security-auditor
        
        Configuration
        =============
        
        The ip2instance configuration file is located at `/etc/ip2instance.yaml` . To
        configure ip2instance create this file and populate it with your
        `role_session_name` and `roles`
        
        role_session_name
        -----------------
        
        The `role_session_name` is an "identifier for the assumed role session. The
        session name is included as part of the AssumedRoleUser" according to the 
        `AWS Documentation`_
        
        roles
        -----
        
        The roles is a list of `ARNs`_ of all IAM Roles in foreign AWS accounts which
        ip2instance should assume when searching for instances.
        
        Example Configuration
        ---------------------
        
        Here is an example configuration for two foreign AWS accounts
        
        ::
        
            role_session_name: ip2instance
            roles:
            - arn:aws:iam::123456789012:role/security-audit-role-SecurityAuditRole-12XHTR13TAWGH  # 293989542403 Finance
            - arn:aws:iam::345678901234:role/security-audit-role-SecurityAuditRole-FLGUX9CF36X6   # 345678901234 Client Frontend Development Team
         
        
        Usage
        =====
        
        ::
        
            ip2instance > instance-list.txt
        
        How to Build
        ============
        
        Here's how to build this into an RPM on a `RHEL 6 derivative`_
        
        ::
        
            sudo yum install http://ftp.linux.ncsu.edu/pub/epel/6/i386/epel-release-6-8.noarch.rpm
            sudo yum install rubygems ruby-devel gcc python-setuptools rpm-build
            sudo easy_install pip
            sudo gem install fpm
            git clone https://github.com/gene1wood/ip2instance.git
            
            cd ip2instance # This is required
            fpm -s python -t rpm --workdir ../ ./setup.py
        
        .. _AWS Documentation: http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
        .. _ARNs: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
        .. _RHEL 6 derivative: https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux_derivatives
Keywords: aws ec2
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Systems Administration
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 2.7
