Deploy obfs4 public Tor bridges to AWS EC2.
It's 100% Open Source and licensed under the BSD 2-clause License.
module "bridge" {
source = "sr2c/tor-bridge/aws"
# TODO: version = "x.x.x"
count = 1 # increase for more bridges
namespace = "<yourorg>"
name = "bridge"
attributes = [tostring(count.index)]
ssh_public_key = var.ssh_public_key
ssh_private_key = var.ssh_private_key
contact_info = "<admin email address>"
}| Name | Version |
|---|---|
| terraform | >= 1.0.11 |
| aws | >= 4.2.0 |
| null | >= 3.2.1 |
| random | >= 3.1.0 |
| Name | Version |
|---|---|
| aws | >= 4.2.0 |
| null | >= 3.2.1 |
| random | >= 3.1.0 |
| Name | Source | Version |
|---|---|---|
| bridgeline | matti/resource/shell | 1.5.0 |
| cloudinit | sr2c/tor/cloudinit | 0.2.4 |
| fingerprint_ed25519 | matti/resource/shell | 1.5.0 |
| fingerprint_rsa | matti/resource/shell | 1.5.0 |
| hashed_fingerprint | matti/resource/shell | 1.5.0 |
| instance | cloudposse/ec2-instance/aws | 0.45.2 |
| this | cloudposse/label/null | 0.25.0 |
| torrc | sr2c/torrc/null | 0.0.4 |
| Name | Type |
|---|---|
| aws_key_pair.this | resource |
| aws_security_group.obfs4 | resource |
| aws_security_group_rule.obfs4 | resource |
| null_resource.wait_for_cloud_init | resource |
| random_integer.obfs_port | resource |
| random_integer.or_port | resource |
| aws_ami.debian | data source |
| aws_availability_zones.available | data source |
| aws_subnet.default | data source |
| aws_vpc.default | data source |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| ami | ID of an alternative AMI to use for the EC2 instance. The latest Debian 11 AMI will be used if left unset. | string |
null |
no |
| ami_owner | The owner ID of the AMI. The Debian organisation's ID will be used if left unset. | string |
null |
no |
| contact_info | Contact information to be published in the bridge descriptor. | string |
n/a | yes |
| descriptor_formats | Describe 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 beidentical to how they appear in id.Default is {} (descriptors output will be empty). |
any |
{} |
no |
| distribution_method | Bridge distribution method | string |
"any" |
no |
| instance_type | EC2 instance size. | string |
"t3.small" |
no |
| ssh_private_key | Filename of private SSH key for provisioning. | string |
n/a | yes |
| ssh_public_key | Filename of public SSH key for provisioning. | string |
n/a | yes |
| ssh_user | Username to use for SSH access (must have password-less sudo enabled). | string |
"admin" |
no |
This Terraform module makes use of the cloudposse/label/null module to generate consistent names and tags for resources. The label module contains many inputs that are common across all our modules that use the label module, and so these inputs have been seperated here to make it clearer which inputs are specific to this module.
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| additional_tag_map | Additional 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 |
| attributes | ID 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 delimiterand treated as a single ID element. |
list(string) |
[] |
no |
| context | Single 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 |
{ |
no |
| delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
no |
| enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
| environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
| id_length_limit | Limit 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. |
number |
null |
no |
| label_key_case | Controls 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. |
string |
null |
no |
| label_order | The 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) |
null |
no |
| label_value_case | Controls 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. |
string |
null |
no |
| labels_as_tags | Set 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 bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
| name | ID 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. |
string |
null |
no |
| namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string |
null |
no |
| regex_replace_chars | Terraform 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. |
string |
null |
no |
| stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
| tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'}).Neither the tag keys nor the tag values will be modified by this module. |
map(string) |
{} |
no |
| tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string |
null |
no |
| Name | Description |
|---|---|
| ansible_inventory | An Ansible inventory line that allows login to the bridge with the correct username. |
| bridgeline | The bridgeline that would allow a Tor client to use this bridge. |
| fingerprint_ed25519 | The Ed25519 fingerprint of this bridge. |
| fingerprint_rsa | The hex-encoded RSA fingerprint of this bridge. |
| hashed_fingerprint | The hex-encoded hashed fingerprint of this bridge. This is used to identify the bridge in public Tor Metrics data. |
| id | An identifier for the bridge formed of the ID elements. |
| ip_address | The IP address of the server. This is treated as sensitive as this information may be used to censor access to the bridge. |
| nickname | The nickname of the bridge published in the bridge descriptors. This is based on the ID, reformatted for the nickname restrictions. |
| obfs_port | The TCP port number used for the obfs4 port. This is treated as sensitive as this information may be used to censor access to the bridge. |
| or_port | The TCP port number used for the OR port. This is treated as sensitive as this information may be used to censor access to the bridge. |
| ssh_user | The username used for SSH access. |
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Like this project? Please give it a ★ on our GitLab! (it helps us a lot)## Related Projects
Check out these related projects.
- terraform-null-torrc - Terraform module used in this module to create the torrc configuration file.
- terraform-null-contactinfo - Terraform module that can be used to create a Tor ContactInfo-Information-Sharing-Speicifcation compliant contact info string.
- terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.
Got a question? We got answers.
File a GitLab issue, send us an email or join our IRC.
Join our public chat on IRC. If you don't have an IRC client already, you can get started with the web client. 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.
Please use the issue tracker to report any bugs or file feature requests.
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, MRs are welcome. We follow the typical "fork-and-pull" Git workflow:
- Fork the repo on GitLab
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Merge Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
We have adopted the Conventional Commits specification for the formatting of commit messages.
Copyright © 2021-2024 SR2 Communications Limited
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained by SR2 Communications Limited.
We're a DevOps services company based in Aberdeen, Scotland. We specialise in solutions for online freedom, digital sovereignty and anti-censorship.
We offer paid support on all of our projects.
Check out our other projects, or hire us to get support with using our projects.
 irl |
|---|