Automate the rotation of IAM keys used by third-party services.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.codeclimate.yml
.eslintignore
.eslintrc.json
.gitignore
.npmignore
.nvmrc
.snyk
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
config.json
configure.js
handler.js
logo.png
package-lock.json
package.json
serverless.yml

README.md

Build Status Code Climate Test Coverage

dependencies Status devDependencies Status

Felix

Felix Logo

Felix rotates your IAM keys!

Managing your IAM keys is a fundamental piece of AWS security. It's also one of the easiest things to get wrong. In fact, the easiest way to manage your IAM keys is to just not ever have any.

But that only gets you so far. Some third-party services can't integrate via cross-account roles or bucket policies. Sometimes you need to run pieces of your infrastructure on-prem or in different Cloud Providers (or otherwise cannot use STS keys).

So Felix is aimed at making it easy to manage IAM keys in third-party services like SumoLogic and GitLab. It aims to be easily extensible by both built-in providers and external plugins.

Configuration and Deployment

Deploying from source

  • Clone this repository (or sls install).
  • npm install
  • Get some IAM or STS keys for your account
  • sls deploy --region [the region you want]
  • npm run configure to perform some first-time config in the Parameter Store.

Configuring

Quickstart with configure.js

There is a configure.js script at the root of this repository that will configure all necessary configuration settings in SSM.

You can run it with npm run configure or node ./configure.js.

NOTE: Make sure you have your proper account, profile, and region set in your AWS config before running this.

This will go through all possible settings, suggest sane defaults, and give you the option to configure some plugins (you can skip plugins you don't plan to use).

Configuration details

Configuration for Felix plugins is generally performed by metafig.

Since most plugins will need some kind of secret value, this makes it easy to configure your plugins without any danger of accidentally hardcoding or committing secret values.

See the default config in config.json.

By default, everything under plugins is run through metafig. In this case, all of the configuration for the gitlab plugin is pulled from the AWS Parameter Store, using the /felix/gitlab path. All of those values are populated into your configuration object and passed to the plugin when it is instantiated.

AWS Settings

By default, all AWS settings are loaded from the SSM Parameter Store at /feilx/aws. It needs the following settings:

  • userPath: The IAM path from which to load all users. This should be /service/ in order to match the default settings. The Lambda execution role only has access to /service/ by default, so whatever you choose should be under there somewhere.
  • snsTopic: The ARN of the SNS topic to publish Felix reports to. This should be the SNS topic that was created by the Felix deployment.

GitLab Settings

By default, all GitLab settings are loaded from the SSM Parameter Store at /felix/gitlab. It needs the following settings:

  • token: A GitLab API token that has access to update build variables for your repositories.
  • url: The BaseUrl to the GitLab instance you wish to connect to (e.g. https://gitlab.mycompany.com/).
  • protectedKeys: A boolean value determining if Felix should mark the build variables containing the keys as protected.

SumoLogic Settings

By default, all SumoLogic settings are loaded from the SSM Parameter Store at /felix/sumologic. It needs the following settings:

  • keyId: A SumoLogic key pair id that has access to update your sources and collectors.
  • secretKey: A SumoLogic key pair key that has access to update your sources and collectors.
  • url: The BaseUrl to the SumoLogic API you wish to talk to (e.g. https://api.us2.sumologic.com/api/v1).

Travis Settings

By default, all SumoLogic settings are loaded from the SSM Parameter Store at /felix/travis. It needs the following settings:

  • token: A TravisCI API Key. You can see the Travis docs for information on generating this.

IAM User Configuration

Felix uses IAM usernames and paths to intuit basic information about what the user is used for and where the keys are stored.

As an example, /service/travis/Cimpress-MCP/felix@travis describes the IAM user used for this project.

Felix tries to manage all users under /service/. The next piece of the path (in this case, /travis/) tells Felix about the desired plugin it should use to manage this user. In this case, the travis plugin. When the user's information is passed to the plugin, it uses the rest of the information to figure out how to address that user's credentials in the service. In this case, it uses the Travis API to manage environment variables in the Cimpress-MCP/Felix repository.

The @travis at the end of the username is discarded by Felix and used only to avoid IAM username colissions in case you, for example, also used sumologic with your application and needed to manage an S3 hosted collector.

The cool thing about this is that Felix can manage all of your keys and users without you needing to write and maintain a complex configuration file. Your users are your source of truth.

IAM User Path Construction

  • GitLab: /service/gitlab/[group]/[project]@gitlab
    • Note: subgroups do not work at this time.
  • Sumo: /service/sumo/[collector]/[source]@sumo
  • Travis: /service/travis/[org]/[repo]@travis