From b81cb57d5930025373cf1cd72fa66f92783c7c35 Mon Sep 17 00:00:00 2001 From: Dmitry Borisov Date: Thu, 29 Jul 2021 21:58:29 +0300 Subject: [PATCH 1/3] Initial commit --- .gitignore | 29 ++++++++++ README.md | 77 +++++++++++++++++++++++++- iam.tf | 52 ++++++++++++++++++ main.tf | 112 ++++++++++++++++++++++++++++++++++++++ sg.tf | 33 +++++++++++ templates/client-data.tpl | 5 ++ templates/user-data.txt | 64 ++++++++++++++++++++++ variables.tf | 112 ++++++++++++++++++++++++++++++++++++++ versions.tf | 16 ++++++ 9 files changed, 499 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 iam.tf create mode 100644 main.tf create mode 100644 sg.tf create mode 100644 templates/client-data.tpl create mode 100644 templates/user-data.txt create mode 100644 variables.tf create mode 100644 versions.tf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..397af32 --- /dev/null +++ b/.gitignore @@ -0,0 +1,29 @@ +# Local .terraform directories +**/.terraform/* + +# Terraform lockfile +.terraform.lock.hcl + +# .tfstate files +*.tfstate +*.tfstate.* + +# Crash log files +crash.log + +# Exclude all .tfvars files, which are likely to contain sentitive data, such as +# password, private keys, and other secrets. These should not be part of version +# control as they are data points which are potentially sensitive and subject +# to change depending on the environment. +*.tfvars + +# Ignore override files as they are usually used to override resources locally and so +# are not checked in +override.tf +override.tf.json +*_override.tf +*_override.tf.json + +# Ignore CLI configuration files +.terraformrc +terraform.rc diff --git a/README.md b/README.md index 699802d..e3b01e3 100644 --- a/README.md +++ b/README.md @@ -1 +1,76 @@ -# terraform-aws-wireguard \ No newline at end of file +# Terraform AWS Wireguard + +This module creates EC2 instance with Wireguard inside. + + +How to use: + + + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.13.5 | +| [aws](#requirement\_aws) | ~> 3.0 | + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | ~> 3.0 | +| [template](#provider\_template) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_autoscaling_group.wireguard_asg](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group) | resource | +| [aws_eip.wireguard](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eip) | resource | +| [aws_iam_instance_profile.wireguard_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource | +| [aws_iam_policy.wireguard_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | +| [aws_iam_role.wireguard_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | +| [aws_iam_role_policy_attachment.wireguard_roleattach](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_launch_configuration.wireguard_launch_config](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_configuration) | resource | +| [aws_route53_record.wireguard](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | +| [aws_security_group.sg_wireguard](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | +| [aws_ami.ubuntu](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source | +| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source | +| [aws_iam_policy_document.ec2_assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | +| [aws_iam_policy_document.wireguard_policy_doc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | +| [template_file.wg_client_data_json](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [ami\_id](#input\_ami\_id) | The AWS AMI to use for the Wireguard server, defaults to the latest Ubuntu 20.04 AMI if not specified. | `any` | `null` | no | +| [asg\_desired\_capacity](#input\_asg\_desired\_capacity) | We may want more than one machine in a scaling group, but 1 is recommended. | `number` | `1` | no | +| [asg\_max\_size](#input\_asg\_max\_size) | We may want more than one machine in a scaling group, but 1 is recommended. | `number` | `1` | no | +| [asg\_min\_size](#input\_asg\_min\_size) | We may want more than one machine in a scaling group, but 1 is recommended. | `number` | `1` | no | +| [aws\_region](#input\_aws\_region) | n/a | `string` | n/a | yes | +| [env](#input\_env) | The name of environment for Wireguard. | `any` | n/a | yes | +| [instance\_type](#input\_instance\_type) | The machine type to launch, some machines may offer higher throughput for higher use cases. | `string` | `"t2.micro"` | no | +| [route53\_geo](#input\_route53\_geo) | Route53 Geolocation config. | `any` | `null` | no | +| [route53\_hosted\_zone\_id](#input\_route53\_hosted\_zone\_id) | Route53 Hosted zone ID. | `string` | `null` | no | +| [route53\_record\_name](#input\_route53\_record\_name) | Route53 Record name. | `string` | `null` | no | +| [ssh\_key\_id](#input\_ssh\_key\_id) | A SSH public key ID to add to the VPN instance. | `any` | n/a | yes | +| [subnet\_ids](#input\_subnet\_ids) | A list of subnets for the Autoscaling Group to use for launching instances. May be a single subnet, but it must be an element in a list. | `list(string)` | n/a | yes | +| [target\_group\_arns](#input\_target\_group\_arns) | Running a scaling group behind an LB requires this variable, default null means it won't be included if not set. | `list(string)` | `null` | no | +| [use\_eip](#input\_use\_eip) | Whether to enable Elastic IP switching code in user-data on wg server startup. If true, eip\_id must also be set to the ID of the Elastic IP. | `bool` | `false` | no | +| [use\_route53](#input\_use\_route53) | Whether to use SSM to store Wireguard Server private key. | `bool` | `false` | no | +| [vpc\_id](#input\_vpc\_id) | The VPC ID in which Terraform will launch the resources. | `any` | n/a | yes | +| [wg\_clients](#input\_wg\_clients) | List of client objects with IP and public key. See Usage in README for details. | `list(object({ friendly_name = string, public_key = string, client_ip = string }))` | n/a | yes | +| [wg\_persistent\_keepalive](#input\_wg\_persistent\_keepalive) | Persistent Keepalive - useful for helping connection stability over NATs. | `number` | `25` | no | +| [wg\_server\_interface](#input\_wg\_server\_interface) | The default interface to forward network traffic to. | `string` | `"eth0"` | no | +| [wg\_server\_net](#input\_wg\_server\_net) | IP range for vpn server - make sure your Client ips are in this range but not the specific ip i.e. not .1 | `string` | `"10.0.0.1/24"` | no | +| [wg\_server\_port](#input\_wg\_server\_port) | Port for the vpn server. | `number` | `51820` | no | +| [wg\_server\_private\_key](#input\_wg\_server\_private\_key) | Wireguard server private key. | `string` | `null` | no | + +## Outputs + +No outputs diff --git a/iam.tf b/iam.tf new file mode 100644 index 0000000..293b362 --- /dev/null +++ b/iam.tf @@ -0,0 +1,52 @@ +data "aws_iam_policy_document" "ec2_assume_role" { + statement { + actions = [ + "sts:AssumeRole" + ] + + principals { + type = "Service" + identifiers = ["ec2.amazonaws.com"] + } + } +} + +data "aws_iam_policy_document" "wireguard_policy_doc" { + statement { + actions = [ + "ec2:AssociateAddress", + "ssm:GetParameter" + ] + + resources = ["*"] + } +} + +data "aws_caller_identity" "current" {} + +resource "aws_iam_policy" "wireguard_policy" { + name = "${var.env}-${var.aws_region}-tf-wireguard" + description = "Terraform Managed. Allows Wireguard instance to attach EIP." + policy = data.aws_iam_policy_document.wireguard_policy_doc.json + count = (var.use_eip ? 1 : 0) # only used for EIP mode +} + +resource "aws_iam_role" "wireguard_role" { + name = "${var.env}-${var.aws_region}-tf-wireguard" + description = "Terraform Managed. Role to allow Wireguard instance to attach EIP." + path = "/" + assume_role_policy = data.aws_iam_policy_document.ec2_assume_role.json + count = (var.use_eip ? 1 : 0) # only used for EIP mode +} + +resource "aws_iam_role_policy_attachment" "wireguard_roleattach" { + role = aws_iam_role.wireguard_role[0].name + policy_arn = aws_iam_policy.wireguard_policy[0].arn + count = (var.use_eip ? 1 : 0) # only used for EIP mode +} + +resource "aws_iam_instance_profile" "wireguard_profile" { + name = "${var.env}-${var.aws_region}-tf-wireguard" + role = aws_iam_role.wireguard_role[0].name + count = (var.use_eip ? 1 : 0) # only used for EIP mode +} diff --git a/main.tf b/main.tf new file mode 100644 index 0000000..08d445e --- /dev/null +++ b/main.tf @@ -0,0 +1,112 @@ +resource "aws_eip" "wireguard" { + vpc = true + tags = { + Name = "${var.env}-wireguard" + } +} + +resource "aws_route53_record" "wireguard" { + count = var.use_route53 ? 1 : 0 + allow_overwrite = true + set_identifier = "${var.env}-${var.aws_region}-wireguard" + zone_id = var.route53_hosted_zone_id + name = var.route53_record_name + type = "A" + ttl = "60" + records = [aws_eip.wireguard.public_ip] + + dynamic "geolocation_routing_policy" { + for_each = try(length(var.route53_geo.policy) > 0 ? var.route53_geo.policy : tomap(false), {}) + + content { + continent = geolocation_routing_policy.value.continent + } + } +} + +data "template_file" "wg_client_data_json" { + template = file("${path.module}/templates/client-data.tpl") + count = length(var.wg_clients) + + vars = { + friendly_name = var.wg_clients[count.index].friendly_name + client_pub_key = var.wg_clients[count.index].public_key + client_ip = var.wg_clients[count.index].client_ip + persistent_keepalive = var.wg_persistent_keepalive + } +} + +data "aws_ami" "ubuntu" { + most_recent = true + filter { + name = "name" + values = ["ubuntu/images/hvm-ssd/ubuntu-focal-20.04-amd64-server-*"] + } + filter { + name = "virtualization-type" + values = ["hvm"] + } + owners = ["099720109477"] # Canonical +} + +resource "aws_launch_configuration" "wireguard_launch_config" { + name_prefix = "${var.env}-wireguard-" + image_id = var.ami_id == null ? data.aws_ami.ubuntu.id : var.ami_id + instance_type = var.instance_type + key_name = var.ssh_key_id + iam_instance_profile = (var.use_eip ? aws_iam_instance_profile.wireguard_profile[0].name : null) + user_data = templatefile("${path.module}/templates/user-data.txt", { + wg_server_private_key = var.wg_server_private_key, + wg_server_net = var.wg_server_net, + wg_server_port = var.wg_server_port, + peers = join("\n", data.template_file.wg_client_data_json.*.rendered), + use_eip = var.use_eip ? "enabled" : "disabled", + eip_id = aws_eip.wireguard.id, + wg_server_interface = var.wg_server_interface + }) + security_groups = [aws_security_group.sg_wireguard.id] + associate_public_ip_address = var.use_eip + + lifecycle { + create_before_destroy = true + } +} + +resource "aws_autoscaling_group" "wireguard_asg" { + name = aws_launch_configuration.wireguard_launch_config.name + launch_configuration = aws_launch_configuration.wireguard_launch_config.name + min_size = var.asg_min_size + desired_capacity = var.asg_desired_capacity + max_size = var.asg_max_size + vpc_zone_identifier = var.subnet_ids + health_check_type = "EC2" + termination_policies = ["OldestLaunchConfiguration", "OldestInstance"] + target_group_arns = var.target_group_arns + + lifecycle { + create_before_destroy = true + } + + tags = [ + { + key = "Name" + value = aws_launch_configuration.wireguard_launch_config.name + propagate_at_launch = true + }, + { + key = "Project" + value = "wireguard" + propagate_at_launch = true + }, + { + key = "env" + value = var.env + propagate_at_launch = true + }, + { + key = "tf-managed" + value = "True" + propagate_at_launch = true + }, + ] +} diff --git a/sg.tf b/sg.tf new file mode 100644 index 0000000..e0f4eb9 --- /dev/null +++ b/sg.tf @@ -0,0 +1,33 @@ +resource "aws_security_group" "sg_wireguard" { + name = "${var.env}-${var.aws_region}-wireguard" + description = "Terraform Managed. Allow Wireguard client traffic from internet." + vpc_id = var.vpc_id + + tags = { + Name = "${var.env}-${var.aws_region}-wireguard" + Project = "wireguard" + tf-managed = "True" + env = var.env + } + + ingress { + from_port = var.wg_server_port + to_port = var.wg_server_port + protocol = "udp" + cidr_blocks = ["0.0.0.0/0"] + } + + ingress { + from_port = 22 + to_port = 22 + protocol = "tcp" + cidr_blocks = ["0.0.0.0/0"] + } + + egress { + from_port = 0 + to_port = 0 + protocol = "-1" + cidr_blocks = ["0.0.0.0/0"] + } +} diff --git a/templates/client-data.tpl b/templates/client-data.tpl new file mode 100644 index 0000000..7177777 --- /dev/null +++ b/templates/client-data.tpl @@ -0,0 +1,5 @@ +[Peer] +# friendly_name = ${friendly_name} +PublicKey = ${client_pub_key} +AllowedIPs = ${client_ip} +PersistentKeepalive = ${persistent_keepalive} \ No newline at end of file diff --git a/templates/user-data.txt b/templates/user-data.txt new file mode 100644 index 0000000..6f9c30a --- /dev/null +++ b/templates/user-data.txt @@ -0,0 +1,64 @@ +#!/bin/bash -v +apt-get update +DEBIAN_FRONTEND=noninteractive apt-get upgrade -y -o Dpkg::Options::="--force-confnew" +apt-get install -y \ + apt-transport-https \ + ca-certificates \ + build-essential \ + software-properties-common \ + unzip \ + curl \ + wget \ + gnupg \ + net-tools \ + jq \ + wireguard-dkms \ + wireguard-tools && \ + rm -rf /var/lib/apt/lists/* + +curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" && \ +unzip awscliv2.zip && \ +rm -f awscliv2.zip && \ +./aws/install + +cat > /etc/wireguard/wg0.conf <<- EOF +[Interface] +Address = ${wg_server_net} +PrivateKey = ${wg_server_private_key} +ListenPort = ${wg_server_port} +PostUp = sysctl -w -q net.ipv4.ip_forward=1 +PostUp = iptables -P FORWARD DROP +PostUp = iptables -A FORWARD -i wg0 -j ACCEPT +PostUp = iptables -t nat -A POSTROUTING -o ENI -j MASQUERADE +PostDown = sysctl -w -q net.ipv4.ip_forward=0 +PostDown = iptables -P FORWARD ACCEPT +PostDown = iptables -D FORWARD -i wg0 -j ACCEPT +PostDown = iptables -t nat -D POSTROUTING -o ENI -j MASQUERADE + +${peers} +EOF + +export ENI=$(ip route get 8.8.8.8 | grep 8.8.8.8 | awk '{print $5}') +sed -i "s/ENI/$ENI/g" /etc/wireguard/wg0.conf + +# Use EIP if it is provided +if [ "${use_eip}" != "disabled" ]; then + export INSTANCE_ID=$(curl -s http://169.254.169.254/latest/meta-data/instance-id) + export REGION=$(curl -fsq http://169.254.169.254/latest/meta-data/placement/availability-zone | sed 's/[a-z]$//') + aws --region $${REGION} ec2 associate-address --allocation-id ${eip_id} --instance-id $${INSTANCE_ID} +fi + +chown -R root:root /etc/wireguard/ +chmod -R og-rwx /etc/wireguard/* +sysctl -p +systemctl enable wg-quick@wg0.service +systemctl start wg-quick@wg0.service + +until systemctl is-active --quiet wg-quick@wg0.service +do + sleep 1 +done + +ufw allow ssh +ufw allow ${wg_server_port}/udp +ufw --force enable \ No newline at end of file diff --git a/variables.tf b/variables.tf new file mode 100644 index 0000000..6ab250d --- /dev/null +++ b/variables.tf @@ -0,0 +1,112 @@ +variable "aws_region" { + type = string +} + +variable "env" { + description = "The name of environment for Wireguard." +} + +variable "ssh_key_id" { + description = "A SSH public key ID to add to the VPN instance." +} + +variable "instance_type" { + default = "t2.micro" + description = "The machine type to launch, some machines may offer higher throughput for higher use cases." +} + +variable "asg_min_size" { + default = 1 + description = "We may want more than one machine in a scaling group, but 1 is recommended." +} + +variable "asg_desired_capacity" { + default = 1 + description = "We may want more than one machine in a scaling group, but 1 is recommended." +} + +variable "asg_max_size" { + default = 1 + description = "We may want more than one machine in a scaling group, but 1 is recommended." +} + +variable "vpc_id" { + description = "The VPC ID in which Terraform will launch the resources." +} + +variable "subnet_ids" { + type = list(string) + description = "A list of subnets for the Autoscaling Group to use for launching instances. May be a single subnet, but it must be an element in a list." +} + +variable "wg_clients" { + type = list(object({ friendly_name = string, public_key = string, client_ip = string })) + description = "List of client objects with IP and public key. See Usage in README for details." +} + +variable "wg_server_net" { + default = "10.0.0.1/24" + description = "IP range for vpn server - make sure your Client ips are in this range but not the specific ip i.e. not .1" +} + +variable "wg_server_port" { + default = 51820 + description = "Port for the vpn server." +} + +variable "wg_persistent_keepalive" { + default = 25 + description = "Persistent Keepalive - useful for helping connection stability over NATs." +} + +variable "use_eip" { + type = bool + default = false + description = "Whether to enable Elastic IP switching code in user-data on wg server startup. If true, eip_id must also be set to the ID of the Elastic IP." +} + +variable "target_group_arns" { + type = list(string) + default = null + description = "Running a scaling group behind an LB requires this variable, default null means it won't be included if not set." +} + +variable "wg_server_private_key" { + type = string + default = null + description = "Wireguard server private key." +} + +variable "ami_id" { + default = null # we check for this and use a data provider since we can't use it here + description = "The AWS AMI to use for the Wireguard server, defaults to the latest Ubuntu 20.04 AMI if not specified." +} + +variable "wg_server_interface" { + default = "eth0" + description = "The default interface to forward network traffic to." +} + +variable "use_route53" { + type = bool + default = false + description = "Whether to use SSM to store Wireguard Server private key." +} + +variable "route53_hosted_zone_id" { + type = string + default = null + description = "Route53 Hosted zone ID." +} + +variable "route53_record_name" { + type = string + default = null + description = "Route53 Record name." +} + +variable "route53_geo" { + type = any + default = null + description = "Route53 Geolocation config." +} diff --git a/versions.tf b/versions.tf new file mode 100644 index 0000000..e4e790f --- /dev/null +++ b/versions.tf @@ -0,0 +1,16 @@ +terraform { + required_version = ">= 0.13.5" + + backend "s3" {} + + required_providers { + aws = { + source = "hashicorp/aws" + version = "~> 3.0" + } + } +} + +provider "aws" { + region = var.aws_region +} From ad3a539b010cdbf642b38822c2df0b19d2d495bb Mon Sep 17 00:00:00 2001 From: Dmitry Borisov Date: Fri, 30 Jul 2021 20:20:39 +0300 Subject: [PATCH 2/3] Fix PR --- LICENSE | 21 -- LICENSE.md | 674 ++++++++++++++++++++++++++++++++++++++ README.md | 42 ++- examples/complete.tf | 28 ++ examples/minimal.tf | 22 ++ iam.tf | 6 +- main.tf | 24 +- sg.tf | 4 +- templates/client-data.tpl | 6 +- templates/user-data.txt | 5 + variables.tf | 39 +-- versions.tf | 4 +- 12 files changed, 779 insertions(+), 96 deletions(-) delete mode 100644 LICENSE create mode 100644 LICENSE.md create mode 100644 examples/complete.tf create mode 100644 examples/minimal.tf diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 95ee9a8..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2021 HazelOps - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..c3f5b52 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,674 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + + Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + +0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +1. Source Code. + +The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + +The Corresponding Source for a work in source code form is that +same work. + +2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + +a) The work must carry prominent notices stating that you modified +it, and giving a relevant date. + +b) The work must carry prominent notices stating that it is +released under this License and any conditions added under section +7. This requirement modifies the requirement in section 4 to +"keep intact all notices". + +c) You must license the entire work, as a whole, under this +License to anyone who comes into possession of a copy. This +License will therefore apply, along with any applicable section 7 +additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no +permission to license the work in any other way, but it does not +invalidate such permission if you have separately received it. + +d) If the work has interactive user interfaces, each must display +Appropriate Legal Notices; however, if the Program has interactive +interfaces that do not display Appropriate Legal Notices, your +work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + +a) Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by the +Corresponding Source fixed on a durable physical medium +customarily used for software interchange. + +b) Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by a +written offer, valid for at least three years and valid for as +long as you offer spare parts or customer support for that product +model, to give anyone who possesses the object code either (1) a +copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical +medium customarily used for software interchange, for a price no +more than your reasonable cost of physically performing this +conveying of source, or (2) access to copy the +Corresponding Source from a network server at no charge. + +c) Convey individual copies of the object code with a copy of the +written offer to provide the Corresponding Source. This +alternative is allowed only occasionally and noncommercially, and +only if you received the object code with such an offer, in accord +with subsection 6b. + +d) Convey the object code by offering access from a designated +place (gratis or for a charge), and offer equivalent access to the +Corresponding Source in the same way through the same place at no +further charge. You need not require recipients to copy the +Corresponding Source along with the object code. If the place to +copy the object code is a network server, the Corresponding Source +may be on a different server (operated by you or a third party) +that supports equivalent copying facilities, provided you maintain +clear directions next to the object code saying where to find the +Corresponding Source. Regardless of what server hosts the +Corresponding Source, you remain obligated to ensure that it is +available for as long as needed to satisfy these requirements. + +e) Convey the object code using peer-to-peer transmission, provided +you inform other peers where the object code and Corresponding +Source of the work are being offered to the general public at no +charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + +a) Disclaiming warranty or limiting liability differently from the +terms of sections 15 and 16 of this License; or + +b) Requiring preservation of specified reasonable legal notices or +author attributions in that material or in the Appropriate Legal +Notices displayed by works containing it; or + +c) Prohibiting misrepresentation of the origin of that material, or +requiring that modified versions of such material be marked in +reasonable ways as different from the original version; or + +d) Limiting the use for publicity purposes of names of licensors or +authors of the material; or + +e) Declining to grant rights under trademark law for use of some +trade names, trademarks, or service marks; or + +f) Requiring indemnification of licensors and authors of that +material by anyone who conveys the material (or modified versions of +it) with contractual assumptions of liability to the recipient, for +any liability that these contractual assumptions directly impose on +those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + +Copyright (C) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) +This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. +This is free software, and you are welcome to redistribute it +under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + +The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index e3b01e3..e48f7ba 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ -# Terraform AWS Wireguard +# Terraform AWS WireGuard -This module creates EC2 instance with Wireguard inside. +A Terraform module to deploy a WireGuard VPN server on AWS. +### Prerequisites +Before using this module, you'll need to: -How to use: +1. Install the [WireGuard tools](https://www.wireguard.com/install/) for your OS. +2. Generate a key pair for each client: + ```bash + wg genkey | tee client1-privatekey | wg pubkey > client1-publickey + ``` +3. Generate a key pair for the server + ```bash + wg genkey | tee server-privatekey | wg pubkey > server-publickey + ``` +4. Add each client's public key, along with the next available IP address to the `wg_clients` list. + +5. Add server's private key to the `wg_server_private_key` variable. You can use AWS SSM Parameter store to store and read server private key. + + + ## Requirements @@ -48,29 +64,25 @@ No modules. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [ami\_id](#input\_ami\_id) | The AWS AMI to use for the Wireguard server, defaults to the latest Ubuntu 20.04 AMI if not specified. | `any` | `null` | no | -| [asg\_desired\_capacity](#input\_asg\_desired\_capacity) | We may want more than one machine in a scaling group, but 1 is recommended. | `number` | `1` | no | -| [asg\_max\_size](#input\_asg\_max\_size) | We may want more than one machine in a scaling group, but 1 is recommended. | `number` | `1` | no | -| [asg\_min\_size](#input\_asg\_min\_size) | We may want more than one machine in a scaling group, but 1 is recommended. | `number` | `1` | no | -| [aws\_region](#input\_aws\_region) | n/a | `string` | n/a | yes | -| [env](#input\_env) | The name of environment for Wireguard. | `any` | n/a | yes | -| [instance\_type](#input\_instance\_type) | The machine type to launch, some machines may offer higher throughput for higher use cases. | `string` | `"t2.micro"` | no | -| [route53\_geo](#input\_route53\_geo) | Route53 Geolocation config. | `any` | `null` | no | +| [env](#input\_env) | The name of environment for WireGuard. Used to differentiate multiple deployments. | `any` | n/a | yes | +| [instance\_type](#input\_instance\_type) | The machine type to launch, some machines may offer higher throughput for higher use cases. | `string` | `"t3.nano"` | no | +| [region](#input\_region) | n/a | `string` | n/a | yes | | [route53\_hosted\_zone\_id](#input\_route53\_hosted\_zone\_id) | Route53 Hosted zone ID. | `string` | `null` | no | | [route53\_record\_name](#input\_route53\_record\_name) | Route53 Record name. | `string` | `null` | no | | [ssh\_key\_id](#input\_ssh\_key\_id) | A SSH public key ID to add to the VPN instance. | `any` | n/a | yes | | [subnet\_ids](#input\_subnet\_ids) | A list of subnets for the Autoscaling Group to use for launching instances. May be a single subnet, but it must be an element in a list. | `list(string)` | n/a | yes | | [target\_group\_arns](#input\_target\_group\_arns) | Running a scaling group behind an LB requires this variable, default null means it won't be included if not set. | `list(string)` | `null` | no | | [use\_eip](#input\_use\_eip) | Whether to enable Elastic IP switching code in user-data on wg server startup. If true, eip\_id must also be set to the ID of the Elastic IP. | `bool` | `false` | no | -| [use\_route53](#input\_use\_route53) | Whether to use SSM to store Wireguard Server private key. | `bool` | `false` | no | +| [use\_route53](#input\_use\_route53) | Whether to use Route53 | `bool` | `false` | no | | [vpc\_id](#input\_vpc\_id) | The VPC ID in which Terraform will launch the resources. | `any` | n/a | yes | -| [wg\_clients](#input\_wg\_clients) | List of client objects with IP and public key. See Usage in README for details. | `list(object({ friendly_name = string, public_key = string, client_ip = string }))` | n/a | yes | +| [wg\_clients](#input\_wg\_clients) | List of client objects with IP and public key. See Usage in README for details. | `list(object({ client_friendly_name = string, client_public_key = string, client_allowed_cidr = string }))` | n/a | yes | | [wg\_persistent\_keepalive](#input\_wg\_persistent\_keepalive) | Persistent Keepalive - useful for helping connection stability over NATs. | `number` | `25` | no | | [wg\_server\_interface](#input\_wg\_server\_interface) | The default interface to forward network traffic to. | `string` | `"eth0"` | no | | [wg\_server\_net](#input\_wg\_server\_net) | IP range for vpn server - make sure your Client ips are in this range but not the specific ip i.e. not .1 | `string` | `"10.0.0.1/24"` | no | | [wg\_server\_port](#input\_wg\_server\_port) | Port for the vpn server. | `number` | `51820` | no | -| [wg\_server\_private\_key](#input\_wg\_server\_private\_key) | Wireguard server private key. | `string` | `null` | no | +| [wg\_server\_private\_key](#input\_wg\_server\_private\_key) | WG server private key. | `string` | n/a | yes | ## Outputs -No outputs +No outputs. + diff --git a/examples/complete.tf b/examples/complete.tf new file mode 100644 index 0000000..309d8e2 --- /dev/null +++ b/examples/complete.tf @@ -0,0 +1,28 @@ +module "wireguard" { + source = "git@github.com:hazelops/terraform-aws-wireguard.git" + env = your-env + region = your-aws-region + use_eip = true + ssh_key_id = "your-ec2-key-id" + instance_type = "t3.nano" + wg_server_net = "10.0.0.1/24" + wg_server_port = 51820 + wg_persistent_keepalive = 25 + wg_server_interface ="eth0" + use_route53 = false + subnet_ids = ["your-vpc-subnets"] + vpc_id = "id-of-your-vpc" + wg_server_private_key = data.aws_ssm_parameter.wireguard_server_private_key.value + wg_clients = [ + { client_friendly_name = "user1" + client_allowed_cidr = "10.0.0.3/24" + client_public_key= "user1-public-key" }, + { client_friendly_name = "user2" + client_allowed_cidr = "10.0.0.4/24" + client_public_key= "user2-public-key" } + ] +} + +data "aws_ssm_parameter" "wireguard_server_private_key" { + name = "/global/wg-server-private-key" +} diff --git a/examples/minimal.tf b/examples/minimal.tf new file mode 100644 index 0000000..0629663 --- /dev/null +++ b/examples/minimal.tf @@ -0,0 +1,22 @@ +module "wireguard" { + source = "git@github.com:hazelops/terraform-aws-wireguard.git" + env = your-env +region = your-aws-region +use_eip = true +ssh_key_id = "your-ec2-key-id" +subnet_ids = ["vpc-subnets"] +vpc_id = <"id-of-your-vpc"> +wg_server_private_key = data.aws_ssm_parameter.wireguard_server_private_key.value +wg_clients = [ +{ client_friendly_name = "user1" + client_allowed_cidr = "10.0.0.3/24" + client_public_key= "user1-public-key" }, +{ client_friendly_name = "user2" + client_allowed_cidr = "10.0.0.4/24" + client_public_key= "user2-public-key" } +] +} + +data "aws_ssm_parameter" "wireguard_server_private_key" { +name = "/global/wg-server-private-key" +} diff --git a/iam.tf b/iam.tf index 293b362..cbeb152 100644 --- a/iam.tf +++ b/iam.tf @@ -25,14 +25,14 @@ data "aws_iam_policy_document" "wireguard_policy_doc" { data "aws_caller_identity" "current" {} resource "aws_iam_policy" "wireguard_policy" { - name = "${var.env}-${var.aws_region}-tf-wireguard" + name = "${var.env}-${var.region}-tf-wireguard" description = "Terraform Managed. Allows Wireguard instance to attach EIP." policy = data.aws_iam_policy_document.wireguard_policy_doc.json count = (var.use_eip ? 1 : 0) # only used for EIP mode } resource "aws_iam_role" "wireguard_role" { - name = "${var.env}-${var.aws_region}-tf-wireguard" + name = "${var.env}-${var.region}-tf-wireguard" description = "Terraform Managed. Role to allow Wireguard instance to attach EIP." path = "/" assume_role_policy = data.aws_iam_policy_document.ec2_assume_role.json @@ -46,7 +46,7 @@ resource "aws_iam_role_policy_attachment" "wireguard_roleattach" { } resource "aws_iam_instance_profile" "wireguard_profile" { - name = "${var.env}-${var.aws_region}-tf-wireguard" + name = "${var.env}-${var.region}-tf-wireguard" role = aws_iam_role.wireguard_role[0].name count = (var.use_eip ? 1 : 0) # only used for EIP mode } diff --git a/main.tf b/main.tf index 08d445e..898cd8f 100644 --- a/main.tf +++ b/main.tf @@ -8,20 +8,12 @@ resource "aws_eip" "wireguard" { resource "aws_route53_record" "wireguard" { count = var.use_route53 ? 1 : 0 allow_overwrite = true - set_identifier = "${var.env}-${var.aws_region}-wireguard" + set_identifier = "${var.env}-${var.region}-wireguard" zone_id = var.route53_hosted_zone_id name = var.route53_record_name type = "A" ttl = "60" records = [aws_eip.wireguard.public_ip] - - dynamic "geolocation_routing_policy" { - for_each = try(length(var.route53_geo.policy) > 0 ? var.route53_geo.policy : tomap(false), {}) - - content { - continent = geolocation_routing_policy.value.continent - } - } } data "template_file" "wg_client_data_json" { @@ -29,9 +21,9 @@ data "template_file" "wg_client_data_json" { count = length(var.wg_clients) vars = { - friendly_name = var.wg_clients[count.index].friendly_name - client_pub_key = var.wg_clients[count.index].public_key - client_ip = var.wg_clients[count.index].client_ip + client_friendly_name = var.wg_clients[count.index].client_friendly_name + client_public_key = var.wg_clients[count.index].client_public_key + client_allowed_cidr = var.wg_clients[count.index].client_allowed_cidr persistent_keepalive = var.wg_persistent_keepalive } } @@ -51,7 +43,7 @@ data "aws_ami" "ubuntu" { resource "aws_launch_configuration" "wireguard_launch_config" { name_prefix = "${var.env}-wireguard-" - image_id = var.ami_id == null ? data.aws_ami.ubuntu.id : var.ami_id + image_id = data.aws_ami.ubuntu.id instance_type = var.instance_type key_name = var.ssh_key_id iam_instance_profile = (var.use_eip ? aws_iam_instance_profile.wireguard_profile[0].name : null) @@ -75,9 +67,9 @@ resource "aws_launch_configuration" "wireguard_launch_config" { resource "aws_autoscaling_group" "wireguard_asg" { name = aws_launch_configuration.wireguard_launch_config.name launch_configuration = aws_launch_configuration.wireguard_launch_config.name - min_size = var.asg_min_size - desired_capacity = var.asg_desired_capacity - max_size = var.asg_max_size + min_size = 1 + desired_capacity = 1 + max_size = 1 vpc_zone_identifier = var.subnet_ids health_check_type = "EC2" termination_policies = ["OldestLaunchConfiguration", "OldestInstance"] diff --git a/sg.tf b/sg.tf index e0f4eb9..ffb884a 100644 --- a/sg.tf +++ b/sg.tf @@ -1,10 +1,10 @@ resource "aws_security_group" "sg_wireguard" { - name = "${var.env}-${var.aws_region}-wireguard" + name = "${var.env}-${var.region}-wireguard" description = "Terraform Managed. Allow Wireguard client traffic from internet." vpc_id = var.vpc_id tags = { - Name = "${var.env}-${var.aws_region}-wireguard" + Name = "${var.env}-${var.region}-wireguard" Project = "wireguard" tf-managed = "True" env = var.env diff --git a/templates/client-data.tpl b/templates/client-data.tpl index 7177777..6d05ee8 100644 --- a/templates/client-data.tpl +++ b/templates/client-data.tpl @@ -1,5 +1,5 @@ [Peer] -# friendly_name = ${friendly_name} -PublicKey = ${client_pub_key} -AllowedIPs = ${client_ip} +# client_friendly_name = ${client_friendly_name} +PublicKey = ${client_public_key} +AllowedIPs = ${client_allowed_cidr} PersistentKeepalive = ${persistent_keepalive} \ No newline at end of file diff --git a/templates/user-data.txt b/templates/user-data.txt index 6f9c30a..7a0a044 100644 --- a/templates/user-data.txt +++ b/templates/user-data.txt @@ -22,6 +22,7 @@ rm -f awscliv2.zip && \ ./aws/install cat > /etc/wireguard/wg0.conf <<- EOF +# Managed by Terraform [Interface] Address = ${wg_server_net} PrivateKey = ${wg_server_private_key} @@ -59,6 +60,10 @@ do sleep 1 done +sysctl -w net.ipv6.conf.all.disable_ipv6=1 +sysctl -w net.ipv6.conf.default.disable_ipv6=1 +sysctl -w net.ipv6.conf.lo.disable_ipv6=1 + ufw allow ssh ufw allow ${wg_server_port}/udp ufw --force enable \ No newline at end of file diff --git a/variables.tf b/variables.tf index 6ab250d..4945756 100644 --- a/variables.tf +++ b/variables.tf @@ -1,9 +1,9 @@ -variable "aws_region" { +variable "region" { type = string } variable "env" { - description = "The name of environment for Wireguard." + description = "The name of environment for WireGuard. Used to differentiate multiple deployments." } variable "ssh_key_id" { @@ -11,25 +11,10 @@ variable "ssh_key_id" { } variable "instance_type" { - default = "t2.micro" + default = "t3.nano" description = "The machine type to launch, some machines may offer higher throughput for higher use cases." } -variable "asg_min_size" { - default = 1 - description = "We may want more than one machine in a scaling group, but 1 is recommended." -} - -variable "asg_desired_capacity" { - default = 1 - description = "We may want more than one machine in a scaling group, but 1 is recommended." -} - -variable "asg_max_size" { - default = 1 - description = "We may want more than one machine in a scaling group, but 1 is recommended." -} - variable "vpc_id" { description = "The VPC ID in which Terraform will launch the resources." } @@ -40,7 +25,7 @@ variable "subnet_ids" { } variable "wg_clients" { - type = list(object({ friendly_name = string, public_key = string, client_ip = string })) + type = list(object({ client_friendly_name = string, client_public_key = string, client_allowed_cidr = string })) description = "List of client objects with IP and public key. See Usage in README for details." } @@ -73,13 +58,7 @@ variable "target_group_arns" { variable "wg_server_private_key" { type = string - default = null - description = "Wireguard server private key." -} - -variable "ami_id" { - default = null # we check for this and use a data provider since we can't use it here - description = "The AWS AMI to use for the Wireguard server, defaults to the latest Ubuntu 20.04 AMI if not specified." + description = "WG server private key." } variable "wg_server_interface" { @@ -90,7 +69,7 @@ variable "wg_server_interface" { variable "use_route53" { type = bool default = false - description = "Whether to use SSM to store Wireguard Server private key." + description = "Whether to use Route53" } variable "route53_hosted_zone_id" { @@ -104,9 +83,3 @@ variable "route53_record_name" { default = null description = "Route53 Record name." } - -variable "route53_geo" { - type = any - default = null - description = "Route53 Geolocation config." -} diff --git a/versions.tf b/versions.tf index e4e790f..597f30c 100644 --- a/versions.tf +++ b/versions.tf @@ -1,8 +1,6 @@ terraform { required_version = ">= 0.13.5" - backend "s3" {} - required_providers { aws = { source = "hashicorp/aws" @@ -12,5 +10,5 @@ terraform { } provider "aws" { - region = var.aws_region + region = var.region } From 3aeccc01992ab7b7a7318705d111e30507fa4d92 Mon Sep 17 00:00:00 2001 From: Dmitry Borisov Date: Fri, 30 Jul 2021 20:40:02 +0300 Subject: [PATCH 3/3] Fix PR2 --- examples/complete.tf | 37 +++++++++++++++++++------------------ examples/minimal.tf | 35 ++++++++++++++++++----------------- 2 files changed, 37 insertions(+), 35 deletions(-) diff --git a/examples/complete.tf b/examples/complete.tf index 309d8e2..bd00a44 100644 --- a/examples/complete.tf +++ b/examples/complete.tf @@ -1,28 +1,29 @@ module "wireguard" { - source = "git@github.com:hazelops/terraform-aws-wireguard.git" - env = your-env - region = your-aws-region - use_eip = true - ssh_key_id = "your-ec2-key-id" - instance_type = "t3.nano" - wg_server_net = "10.0.0.1/24" - wg_server_port = 51820 + source = "hazelops/wireguard/aws" + version = "~>1.0" + env = your-env + region = your-aws-region + use_eip = true + ssh_key_id = "your-ec2-key-id" + instance_type = "t3.nano" + wg_server_net = "10.0.0.1/24" + wg_server_port = 51820 wg_persistent_keepalive = 25 - wg_server_interface ="eth0" - use_route53 = false - subnet_ids = ["your-vpc-subnets"] - vpc_id = "id-of-your-vpc" - wg_server_private_key = data.aws_ssm_parameter.wireguard_server_private_key.value + wg_server_interface = "eth0" + use_route53 = false + subnet_ids = ["your-vpc-subnets"] + vpc_id = "id-of-your-vpc" + wg_server_private_key = data.aws_ssm_parameter.wireguard_server_private_key.value wg_clients = [ { client_friendly_name = "user1" - client_allowed_cidr = "10.0.0.3/24" - client_public_key= "user1-public-key" }, + client_allowed_cidr = "10.0.0.3/24" + client_public_key = "user1-public-key" }, { client_friendly_name = "user2" - client_allowed_cidr = "10.0.0.4/24" - client_public_key= "user2-public-key" } + client_allowed_cidr = "10.0.0.4/24" + client_public_key = "user2-public-key" } ] } data "aws_ssm_parameter" "wireguard_server_private_key" { - name = "/global/wg-server-private-key" + name = "/mgmt/wg-server-private-key" } diff --git a/examples/minimal.tf b/examples/minimal.tf index 0629663..2c5d967 100644 --- a/examples/minimal.tf +++ b/examples/minimal.tf @@ -1,22 +1,23 @@ module "wireguard" { - source = "git@github.com:hazelops/terraform-aws-wireguard.git" - env = your-env -region = your-aws-region -use_eip = true -ssh_key_id = "your-ec2-key-id" -subnet_ids = ["vpc-subnets"] -vpc_id = <"id-of-your-vpc"> -wg_server_private_key = data.aws_ssm_parameter.wireguard_server_private_key.value -wg_clients = [ -{ client_friendly_name = "user1" - client_allowed_cidr = "10.0.0.3/24" - client_public_key= "user1-public-key" }, -{ client_friendly_name = "user2" - client_allowed_cidr = "10.0.0.4/24" - client_public_key= "user2-public-key" } -] + source = "hazelops/wireguard/aws" + version = "~>1.0" + env = your-env + region = your-aws-region + use_eip = true + ssh_key_id = "your-ec2-key-id" + subnet_ids = ["vpc-subnets"] + vpc_id = "id-of-your-vpc" + wg_server_private_key = data.aws_ssm_parameter.wireguard_server_private_key.value + wg_clients = [ + { client_friendly_name = "user1" + client_allowed_cidr = "10.0.0.3/24" + client_public_key = "user1-public-key" }, + { client_friendly_name = "user2" + client_allowed_cidr = "10.0.0.4/24" + client_public_key = "user2-public-key" } + ] } data "aws_ssm_parameter" "wireguard_server_private_key" { -name = "/global/wg-server-private-key" + name = "/mgmt/wg-server-private-key" }