Updated February 26, 2023

Deploy obfs4 public Tor bridges to AWS EC2.


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>"


terraform>= 1.0.11
aws>= 4.2.0
null>= 3.2.1
random>= 3.1.0






aws_ami.debiandata source
aws_availability_zones.availabledata source
aws_subnet.defaultdata source
aws_vpc.defaultdata source


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.
amiID of an alternative AMI to use for the EC2 instance. The latest Debian 11 AMI will be used if left unset.stringnullno
ami_ownerThe owner ID of the AMI. The Debian organisation’s ID will be used if left unset.stringnullno
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.
contact_infoContact information to be published in the bridge descriptor.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.
“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”: [
“name”: null,
“namespace”: null,
“regex_replace_chars”: null,
“stage”: null,
“tags”: {},
“tenant”: null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
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).
distribution_methodBridge distribution methodstring"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.
instance_typeEC2 instance size.string"t3.small"no
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.
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.
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.
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.
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.
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.
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.
ssh_private_keyFilename of private SSH key for provisioning.stringn/ayes
ssh_public_keyFilename of public SSH key for provisioning.stringn/ayes
ssh_userUsername to use for SSH access (must have password-less sudo enabled).string"admin"no
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.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


ansible_inventoryAn Ansible inventory line that allows login to the bridge with the correct username.
bridgelineThe bridgeline that would allow a Tor client to use this bridge.
fingerprint_ed25519The Ed25519 fingerprint of this bridge.
fingerprint_rsaThe hex-encoded RSA fingerprint of this bridge.
hashed_fingerprintThe hex-encoded hashed fingerprint of this bridge. This is used to identify the bridge in public Tor Metrics data.
idAn identifier for the bridge formed of the ID elements.
ip_addressThe IP address of the server. This is treated as sensitive as this information may be used to censor access to the bridge.
nicknameThe nickname of the bridge published in the bridge descriptors. This is based on the ID, reformatted for the nickname restrictions.
obfs_portThe 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_portThe 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_userThe username used for SSH access.