terraform-openstack-tor-bridge

Updated February 26, 2023

Deploy obfs4 public Tor bridges to Openstack infrastructure. Many defaults of this module’s variables are specific to OVH, but left configurable to be able to be used on other Openstack providers.

Usage

Example: OVH

provider "openstack" {
  auth_url    = "https://auth.cloud.ovh.net/v3/"
  domain_name = "Default" # Domain name - Always at 'default' for OVHcloud
  user_name = "<horizon username>"
  password = "<horizon password>"
  tenant_id = "<find in your openrc.sh downloaded from horizon>"
}

locals {
  ssh_public_key  = "~/.ssh/id_rsa.pub"
  ssh_private_key = "~/.ssh/id_rsa"
}

module "bridge" {
  source          = "sr2c/tor-bridge/openstack"
  # TODO: version         = "x.x.x"
  count           = 1  # increase for more bridges
  namespace       = "<yourorg>"
  name            = "bridge"
  attributes      = [tostring(count.index)]
  region          = "UK1"
  ssh_public_key  = local.ssh_public_key
  ssh_private_key = local.ssh_private_key
  contact_info    = "<admin email address>"
}

Example: GandiCloud VPS

provider "openstack" {
  auth_url    = "https://keystone.sd6.api.gandi.net:5000/v3"
  domain_name = "public" # Always at 'public' for GandiCloud VPS
  region      = "FR-SD6" # This is the only region available at time of writing
  user_name   = "<Gandi v5 username>"
  password    = "<Gandi v5 password>"
  tenant_name = "<Gandi organisation name>"
}

locals {
  ssh_public_key  = "~/.ssh/id_rsa.pub"
  ssh_private_key = "~/.ssh/id_rsa"
}

module "bridge" {
  source          = "sr2c/tor-bridge/openstack"
  # TODO: version         = "x.x.x"
  count           = 1 # increase for more bridges
  namespace       = "<yourorg>"
  name            = "bridge"
  attributes      = [tostring(count.index)]
  region          = ""
  ssh_public_key  = local.ssh_public_key
  ssh_private_key = local.ssh_private_key
  contact_info    = "<admin email address>"

  image_name                    = "Debian 11 Bullseye"  # GandiCloud VPS specific value
  flavor_name                   = "V-R1"                # GandiCloud VPS specific value
  external_network_name         = "public"              # GandiCloud VPS specific value
  require_block_device_creation = true                  # GandiCloud VPS specific value
}

Requirements

Name	Version
terraform	>= 0.15.0
openstack	~> 1.42.0
random	3.1.0

Providers

Name	Version
openstack	1.42.0
random	3.1.0

Modules

Name	Source	Version
bridgeline	matti/resource/shell	1.5.0
fingerprint_ed25519	matti/resource/shell	1.5.0
fingerprint_rsa	matti/resource/shell	1.5.0
hashed_fingerprint	matti/resource/shell	1.5.0
this	cloudposse/label/null	0.25.0
torrc	sr2c/torrc/null	0.0.4
user_data	sr2c/tor/cloudinit	0.1.0

Resources

Name	Type
openstack_compute_instance_v2.this	resource
openstack_compute_keypair_v2.this	resource
random_integer.obfs_port	resource
random_integer.or_port	resource
openstack_images_image_v2.block_device	data source

Inputs

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 `delimiter` and treated as a single ID element.	`list(string)`	`[]`	no
contact_info	Contact information to be published in the bridge descriptor.	`string`	n/a	yes
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`	{ “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
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
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 be identical to how they appear in `id`. Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
distribution_method	Bridge distribution method	`string`	`"any"`	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
external_network_name	Name of the Openstack network that provides Internet access.	`string`	`"Ext-Net"`	no
flavor_name	Name of the flavor to use for the compute instance.	`string`	`"d2-2"`	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
image_name	Name of the image to use for the compute instance (must be Debian 11 based).	`string`	`"Debian 11"`	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 be changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	[ “default” ]	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
region	Region to deploy the instance in.	`string`	`null`	no
require_block_device_creation	Create a block device in addition to the server (only needed if not created automatically with instance).	`bool`	`false`	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`	`"debian"`	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

Outputs

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.

Tags: