ec2-client-vpn

This component is responsible for provisioning VPN Client Endpoints.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component. This component should only be applied once as the resources it creates are regional. This is typically done via the corp stack (e.g. uw2-corp.yaml). This is because a vpc endpoint requires a vpc and the network stack does not have a vpc.

components:
  terraform:
    ec2-client-vpn:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        client_cidr: 10.100.0.0/10
        logging_stream_name: client_vpn
        logging_enabled: true
        retention_in_days: 7
        organization_name: acme
        split_tunnel: true
        availability_zones:
          - us-west-2a
          - us-west-2b
          - us-west-2c
        associated_security_group_ids: []
        additional_routes:
          - destination_cidr_block: 0.0.0.0/0
            description: Internet Route
        authorization_rules:
          - name: Internet Rule
            authorize_all_groups: true
            description: Allows routing to the internet"
            target_network_cidr: 0.0.0.0/0

Deploying

NOTE: This module uses the aws_ec2_client_vpn_route resource which throws an error if too many API calls come from a single host. Ignore this error and repeat the terraform command. It usually takes 3 deploys (or destroys) to complete.

Error on create (See issue https://github.com/hashicorp/terraform-provider-aws/issues/19750)

ConcurrentMutationLimitExceeded: Cannot initiate another change for this endpoint at this time. Please try again later.

Error on destroy (See issue https://github.com/hashicorp/terraform-provider-aws/issues/16645)

timeout while waiting for resource to be gone (last state: 'deleting', timeout: 1m0s)

Testing

NOTE: The GoogleIDPMetadata-cloudposse.com.xml in this repo is equivalent to the one in the sso component and is used for testing. This component can only specify a single SAML document. The customer SAML xml should be placed in this directory side-by-side the CloudPosse SAML xml.

Prior to testing, the component needs to be deployed and the AWS client app needs to be setup by the IdP admin otherwise the following steps will result in an error similar to app_not_configured_for_user.

Deploy the component in a regional account with a VPC like ue2-corp.
Copy the contents of client_configuration into a file called client_configuration.ovpn
Download AWS client VPN brew install --cask aws-vpn-client
Launch the VPN
File > Manage Profiles to open the Manage Profiles window
Click Add Profile to open the Add Profile window
Set the display name e.g. <tenant>-<environment>-<stage>
Click the folder icon and find the file that was saved in a previous step
Click Add Profile to save the profile
Click Done to close to Manage Profiles window
Under "Ready to connect.", choose the profile, and click Connect

A browser will launch and allow you to connect to the VPN.

Make a note of where this component is deployed
Ensure that the resource to connect to is in a VPC that is connected by the transit gateway
Ensure that the resource to connect to contains a security group with a rule that allows ingress from where the client vpn is deployed (e.g. ue2-corp)
Use nmap to test if the port is open. If the port is filtered then it's not open.

nmap -p <PORT> <HOST>

Successful tests have been seen with MSK and RDS.

Variables

Required Variables

authorization_rules required

List of objects describing the authorization rules for the Client VPN. Each Target Network CIDR range given will be used to create an additional route attached to the Client VPN endpoint with the same Description.

Type:

list(object({
name                 = string
access_group_id      = string
authorize_all_groups = bool
description          = string
target_network_cidr  = string
}))

client_cidr (string) required

Network CIDR to use for clients

logging_stream_name (string) required

Names of stream used for logging

organization_name (string) required

Name of organization to use in private certificate

region (string) required

VPN Endpoints are region-specific. This identifies the region. AWS Region

Optional Variables

associated_security_group_ids (list(string)) optional

List of security groups to attach to the client vpn network associations

Default value: [ ]

authentication_type (string) optional

One of certificate-authentication or federated-authentication

Default value: "certificate-authentication"

ca_common_name (string) optional

Unique Common Name for CA self-signed certificate

Default value: null

dns_servers (list(string)) optional

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.

Default value: [ ]

export_client_certificate (bool) optional

Flag to determine whether to export the client certificate with the VPN configuration

Default value: true

logging_enabled (bool) optional

Enables or disables Client VPN Cloudwatch logging.

Default value: false

retention_in_days (number) optional

Number of days you want to retain log events in the log group

Default value: 30

root_common_name (string) optional

Unique Common Name for Root self-signed certificate

Default value: null

saml_metadata_document (string) optional

Optional SAML metadata document. Must include this or saml_provider_arn

Default value: null

saml_provider_arn (string) optional

Optional SAML provider ARN. Must include this or saml_metadata_document

Default value: null

server_common_name (string) optional

Unique Common Name for Server self-signed certificate

Default value: null

split_tunnel (bool) optional

Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false.

Default value: false

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

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

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

client_configuration: VPN Client Configuration file (.ovpn) contents that can be imported into AWS client vpn
full_client_configuration: Client configuration including client certificate and private key for mutual authentication
vpn_endpoint_arn: The ARN of the Client VPN Endpoint Connection.
vpn_endpoint_dns_name: The DNS Name of the Client VPN Endpoint Connection.
vpn_endpoint_id: The ID of the Client VPN Endpoint Connection.

Dependencies

Requirements

terraform, version: >= 1.0
aws, version: >= 4.0
awsutils, version: >= 0.11.0

Modules

Name	Version	Source	Description
`ec2_client_vpn`	0.14.0	`cloudposse/ec2-client-vpn/aws`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`vpc`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a

References

cloudposse/terraform-aws-ec2-client-vpn - Cloud Posse's upstream component
cloudposse/awsutils - Cloud Posse's awsutils provider

Usage​

Deploying​

Testing​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Modules​

References​

Usage

Deploying

Testing

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Modules

References