Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/infrablocks/terraform-aws-access-control
A Terraform module for configuring AWS account access control.
https://github.com/infrablocks/terraform-aws-access-control
access-control aws infrastructure terraform terraform-modules
Last synced: about 2 months ago
JSON representation
A Terraform module for configuring AWS account access control.
- Host: GitHub
- URL: https://github.com/infrablocks/terraform-aws-access-control
- Owner: infrablocks
- License: mit
- Created: 2019-11-21T22:01:35.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T16:00:23.000Z (2 months ago)
- Last Synced: 2024-10-28T18:07:12.923Z (2 months ago)
- Topics: access-control, aws, infrastructure, terraform, terraform-modules
- Language: Ruby
- Homepage:
- Size: 538 KB
- Stars: 2
- Watchers: 7
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Terraform AWS Access Control
============================
[](https://github.com/infrablocks/terraform-aws-access-control/tags)
[](https://app.circleci.com/pipelines/github/infrablocks/terraform-aws-access-control?filter=all)
[](https://go-atomic.io)
A Terraform module for configuring AWS account access control.
The access control deployment has no requirements.
The access control deployment consists of:
* A set of users, each having
* a login profile (optional)
* an access key (optional)
* MFA enforced (optional)
* A set of group, each having
* a set of users, defined above or otherwise
* a set of attached policies
* a set of assumable roles
Usage
-----
To use the module, include something like the following in your Terraform
configuration:
```terraform
module "access_control" {
source = "infrablocks/access-control/aws"
version = "3.0.0"
users = [
{
name = "[email protected]"
password_length = 32
public_gpg_key = filebase64("${path.root}/keys/user.gpg")
enforce_mfa = "yes"
include_login_profile = "yes"
include_access_key = "yes"
enabled = "yes"
}
]
groups = [
{
name = "admins"
users = ["[email protected]"]
policies = ["arn:aws:iam::aws:policy/AdministratorAccess"]
assumable_roles = []
}
]
}
```
See the
[Terraform registry entry](https://registry.terraform.io/modules/infrablocks/access-control/aws/latest)
for more details.
### Inputs
| Name | Description | Default | Required |
|----------|-------------------------------|:-------:|:--------:|
| `users` | The list of users to manage. | - | Yes |
| `groups` | The list of groups to manage. | - | Yes |
### Outputs
| Name | Description |
|----------|--------------------------------|
| `users` | Details of the managed users. |
| `groups` | Details of the managed groups. |
### Compatibility
This module is compatible with Terraform versions greater than or equal to
Terraform 1.0.
Development
-----------
### Machine Requirements
In order for the build to run correctly, a few tools will need to be installed
on your development machine:
* Ruby (3.1)
* Bundler
* git
* git-crypt
* gnupg
* direnv
* aws-vault
#### Mac OS X Setup
Installing the required tools is best managed by [homebrew](http://brew.sh).
To install homebrew:
```shell
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
Then, to install the required tools:
```shell
# ruby
brew install rbenv
brew install ruby-build
echo 'eval "$(rbenv init - bash)"' >> ~/.bash_profile
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
eval "$(rbenv init -)"
rbenv install 3.1.1
rbenv rehash
rbenv local 3.1.1
gem install bundler
# git, git-crypt, gnupg
brew install git
brew install git-crypt
brew install gnupg
# aws-vault
brew cask install
# direnv
brew install direnv
echo "$(direnv hook bash)" >> ~/.bash_profile
echo "$(direnv hook zsh)" >> ~/.zshrc
eval "$(direnv hook $SHELL)"
direnv allow
```
### Running the build
Running the build requires an AWS account and AWS credentials. You are free to
configure credentials however you like as long as an access key ID and secret
access key are available. These instructions utilise
[aws-vault](https://github.com/99designs/aws-vault) which makes credential
management easy and secure.
To run the full build, including unit and integration tests, execute:
```shell
aws-vault exec -- ./go
```
To run the unit tests, execute:
```shell
aws-vault exec -- ./go test:unit
```
To run the integration tests, execute:
```shell
aws-vault exec -- ./go test:integration
```
To provision the module prerequisites:
```shell
aws-vault exec -- ./go deployment:prerequisites:provision[]
```
To provision the module contents:
```shell
aws-vault exec -- ./go deployment:root:provision[]
```
To destroy the module contents:
```shell
aws-vault exec -- ./go deployment:root:destroy[]
```
To destroy the module prerequisites:
```shell
aws-vault exec -- ./go deployment:prerequisites:destroy[]
```
Configuration parameters can be overridden via environment variables. For
example, to run the unit tests with a seed of `"testing"`, execute:
```shell
SEED=testing aws-vault exec -- ./go test:unit
```
When a seed is provided via an environment variable, infrastructure will not be
destroyed at the end of test execution. This can be useful during development
to avoid lengthy provision and destroy cycles.
To subsequently destroy unit test infrastructure for a given seed:
```shell
FORCE_DESTROY=yes SEED=testing aws-vault exec -- ./go test:unit
```
### Common Tasks
#### Generating an SSH key pair
To generate an SSH key pair:
```
ssh-keygen -m PEM -t rsa -b 4096 -C [email protected] -N '' -f config/secrets/keys/bastion/ssh
```
#### Generating a self-signed certificate
To generate a self signed certificate:
```
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365
```
To decrypt the resulting key:
```
openssl rsa -in key.pem -out ssl.key
```
#### Managing CircleCI keys
To encrypt a GPG key for use by CircleCI:
```shell
openssl aes-256-cbc \
-e \
-md sha1 \
-in ./config/secrets/ci/gpg.private \
-out ./.circleci/gpg.private.enc \
-k ""
```
To check decryption is working correctly:
```shell
openssl aes-256-cbc \
-d \
-md sha1 \
-in ./.circleci/gpg.private.enc \
-k ""
```
Contributing
------------
Bug reports and pull requests are welcome on GitHub at
https://github.com/infrablocks/terraform-aws-access-control.
This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to
the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
License
-------
The library is available as open source under the terms of the
[MIT License](http://opensource.org/licenses/MIT).