terraform-aws-bc-eotk


Updated December 7, 2022
Source code

Terraform module to deploy Bypass Censorship Enterprise Onion Toolkit instances in AWS.

This module supports creating multiple EC2 instances, each serving the same selection of onion services. Due to the way that onion services are published, this provides basic load balancing and failover, although there is no direct coordination between the EOTK instances.

Each EC2 instance is deployed to a separate availability zone (up to a maximum number of the number of available availability zones within the region).

The nginx reverse proxy server configured by EOTK on each instance will keep access logs and these will be rotated hourly. On rotation, the logs will be copied to an S3 bucket for processing by an analytics system.

Rather than replace the EC2 instance on every update, which would be difficult given that EOTK builds tor and OpenResty from source as part of the installation process (time consuming), a script is installed to reconfigure EOTK every 25 minutes with any updated configuration bundle uploaded to the S3 bucket. The EC2 instances should still be considered “disposable” however, as new AMIs will cause EC2 instance replacement.

terraform-aws-bc-eotk overview


It’s 100% Open Source and licensed under the BSD 2-clause License.

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

Before the module may be used, a zip file containing the EOTK configuration and the necessary Onion and TLS keys and certificates must be created. This may be done with archive_file or with a tool like deterministic-zip if it is acceptable to have a non-Terraform solution for that part. No directory structure is used within the zip file, it has only a flat structure. To begin, create a file named sites.conf that contains your EOTK configuration, for example:

set log_separate 1

set nginx_resolver 127.0.0.53 ipv6=off  # The EC2 instance will have systemd-resolved

set nginx_cache_seconds 60  # Handle bursts, but don't cache anything too long
set nginx_cache_size 64m
set nginx_tmpfile_size 8m

set x_from_onion_value 1

foreignmap facebookwkhpilnemxj7asaniu7vnjjbiltxjqhye3mhbshg7kx5tfyd.onion facebook.com
foreignmap twitter3e4tixl4xyajtrzo62zg5vztmjuricljdp2c5kshju4avyoid.onion twitter.com

set project sites

hardmap systems3hwkxej5nzmo6kvwgx6sik2plqe4w3lsqglr6xhvyi2xlsmqd test.sr2.uk

For each onion service, you’ll need to include 4 more files in the zip file:

  • <onion address without .onion>.v3sec.key - Onion secret key
  • <onion address without .onion>.v3pub.key - Onion public key
  • <first 20 characters of onion address>-v3.pem - TLS private key (PEM encoded)
  • <first 20 characters of onion address>-v3.cert - TLS certificate (PEM encoded)

For the example given above, these files would be named:

  • systems3hwkxej5nzmo6kvwgx6sik2plqe4w3lsqglr6xhvyi2xlsmqd.v3sec.key - Onion secret key
  • systems3hwkxej5nzmo6kvwgx6sik2plqe4w3lsqglr6xhvyi2xlsmqd.v3pub.key - Onion public key
  • systems3hwkxej5nzmo6-v3.cert - TLS private key (PEM encoded)
  • systems3hwkxej5nzmo6-v3.pem - TLS certificate (PEM encoded)

You can then use the module to create EC2 instances and other resources to run EOTK and serve the onion site:

module "eotk" {
  source               = "sr2c/bc-eotk/aws"
  namespace            = "eg"
  name                 = "bc-eotk"
  instance_count       = 1
  configuration_bundle = "configuration.zip"
}

Requirements

NameVersion
terraform>= 1.3.0
aws>= 4.4.0
cloudinit>= 2.2.0

Providers

NameVersion
aws4.40.0
cloudinit2.2.0

Modules

NameSourceVersion
conf_logsr2c/ec2-conf-log/aws0.0.2
instancecloudposse/ec2-instance/aws0.45.0
thiscloudposse/label/null0.25.0

Resources

NameType
aws_s3_object.configuration_bundleresource
aws_ami.ubuntudata source
aws_availability_zones.availabledata source
aws_subnet.defaultdata source
aws_vpc.defaultdata source
cloudinit_config.thisdata source

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string){}no
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string)[]no
configuration_bundlePath to the zip file that contains the configuration bundle to be uploaded to the configuration bucket.stringn/ayes
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
“additional_tag_map”: {},
“attributes”: [],
“delimiter”: null,
“descriptor_formats”: {},
“enabled”: true,
“environment”: null,
“id_length_limit”: null,
“label_key_case”: null,
“label_order”: [],
“label_value_case”: null,
“labels_as_tags”: [
“unset”
],
“name”: null,
“namespace”: null,
“regex_replace_chars”: null,
“stage”: null,
“tags”: {},
“tenant”: null
}
no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br> format = string<br> labels = list(string)<br>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any{}no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. ‘uw2’, ‘us-west-2’, OR role ‘prod’, ‘staging’, ‘dev’, ‘UAT’stringnullno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
numbernullno
instance_countNumber of EC2 instances to create. If the number specified is more than the number of available availability zones,
the number of instances will be capped to the number of available availability zones. If the number is zero then no
instances will be created.
number2no
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
stringnullno
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to [“namespace”, “environment”, “stage”, “name”, “attributes”].
You can omit any of the 6 labels (“tenant” is the 6th), but at least one must be present.
list(string)nullno
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
stringnullno
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
“default”
]
no
nameID element. Usually the component or solution name, e.g. ‘app’ or ‘jenkins’.
This is the only ID element not also included as a tag.
The “name” tag is set to the full id string. There is no tag with the value of the name input.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. ’eg’ or ‘cp’, to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
stringnullno
stageID element. Usually used to indicate role, e.g. ‘prod’, ‘staging’, ‘source’, ‘build’, ’test’, ‘deploy’, ‘release’stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
instancesAn object mapping the availability zone in use to the instance ID for the created EC2 instance running EOTK in that
availability zone.
log_bucket_arnThe ARN of the log bucket created to hold the nginx access logs.
log_bucket_idThe ID of the log bucket created to hold the nginx access logs.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

References

For additional context, refer to some of these links.

Help

Got a question? We got answers.

File a GitLab issue, send us an email or join our Matrix Community.

README Commercial Support

Matrix Community

Matrix badge

Join our Open Source Community on Matrix. It’s FREE for everyone! This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build on our open source code.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical “fork-and-pull” Git workflow.

  1. Fork the repo on GitLab
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from “upstream” before making a pull request!

Copyright © 2021-2022 SR2 Communications Limited

License

License: BSD 2-clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
   disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
   disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained by SR2 Communications Limited.

SR2 Communications Limited

We’re a DevOps Professional Services company based in Aberdeen, Scotland. We ❤️ open source software and specialise in digital human rights and humanitarian projects.

We offer paid support on all of our projects.

Check out our other projects, or hire us to get support with using our projects.

Contributors

irl
irl
aws terraform ec2 bypass-censorship tor onion-services eotk