├── .gitignore ├── vxlan2pcap ├── go │ ├── vxlan2pcap │ └── src │ │ └── vxlan2pcap.go ├── README.md └── python │ └── vxlan2pcap.py ├── .github └── workflows │ ├── leaktest.yml │ └── contrib.yml ├── terraform ├── aws │ ├── destroy_so │ ├── launch_so │ ├── terraform.tfvars │ ├── outputs.tf │ ├── prep_so │ ├── ubuntu.tf │ ├── vpc.tf │ ├── windows.tf │ ├── variables.tf │ ├── install-terraform-awscli.sh │ ├── README.md │ ├── so.tf │ ├── automirror.tf │ └── AutoMirror │ │ ├── auto_mirror_lambda.js │ │ └── LICENSE └── gcp │ ├── provider.tf │ ├── outputs.tf │ ├── ubuntu.tf │ ├── variables.tf │ ├── subnets.tf │ ├── backend.tf │ ├── terraform.tfvars │ ├── firewall.tf │ ├── vpc.tf │ ├── mirror.tf │ ├── sensor.tf │ ├── install-terraform.sh │ └── README.md ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.tfstate* 2 | .terraform 3 | -------------------------------------------------------------------------------- /vxlan2pcap/go/vxlan2pcap: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Security-Onion-Solutions/securityonion-cloud/HEAD/vxlan2pcap/go/vxlan2pcap -------------------------------------------------------------------------------- /.github/workflows/leaktest.yml: -------------------------------------------------------------------------------- 1 | name: leak-test 2 | 3 | on: [push,pull_request] 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | 9 | steps: 10 | - uses: actions/checkout@v2 11 | with: 12 | fetch-depth: '0' 13 | 14 | - name: Gitleaks 15 | uses: gitleaks/gitleaks-action@v1.6.0 16 | 17 | -------------------------------------------------------------------------------- /terraform/aws/destroy_so: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Destroy instances 4 | terraform destroy --auto-approve 5 | # Remove allowed IP from terraform.tfvars 6 | echo "Resetting EXTERNAL_IP variable...may prompt for credentials..." 7 | sudo sed -i 's|^ip_whitelist.*|ip_whitelist = ["0.0.0.0/32"] #Change this to your public ip/32|' terraform.tfvars 8 | -------------------------------------------------------------------------------- /terraform/aws/launch_so: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Get external IP, and add to allow list for security group 4 | EXTERNAL_IP=$(dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}') 5 | sed -i "s|^ip_whitelist.*|ip_whitelist = [\"$EXTERNAL_IP/32\"] #Change this to your public ip/32|" terraform.tfvars 6 | 7 | # Apply Terraform state 8 | terraform init 9 | terraform apply --auto-approve 10 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Security Onion in the Cloud 2 | **NOTE: The scripts in the accompanying links are NOT guaranteed or recommended for production use.** 3 | 4 | ### Security Onion in AWS 5 | See: [AWS](https://github.com/Security-Onion-Solutions/securityonion-cloud/tree/master/terraform/aws) 6 | 7 | ### Decapsulating VXLAN-encapsulated PCAP 8 | See: [VXLAN2PCAP](https://github.com/Security-Onion-Solutions/securityonion-cloud/tree/master/vxlan2pcap) 9 | -------------------------------------------------------------------------------- /terraform/gcp/provider.tf: -------------------------------------------------------------------------------- 1 | // Configure the Google Cloud provider 2 | provider "google" { 3 | credentials = "${file("${var.shared_credentials_file}")}" 4 | project = "${var.project}" 5 | region = "${var.region}" 6 | } 7 | 8 | // Configure the Google Cloud Beta provider 9 | provider "google-beta" { 10 | credentials = "${file("${var.shared_credentials_file}")}" 11 | project = "${var.project}" 12 | region = "${var.region}" 13 | } 14 | 15 | -------------------------------------------------------------------------------- /terraform/gcp/outputs.tf: -------------------------------------------------------------------------------- 1 | output "Region" { 2 | value = var.region 3 | } 4 | 5 | output "securityonion_public_ips" { 6 | description = "Security Onion Public IP Address(es)" 7 | value = google_compute_instance.sensor.network_interface[0].access_config[0].nat_ip 8 | } 9 | 10 | output "ubuntu_public_ips" { 11 | description = "Ubuntu Instance IP Address(es)" 12 | value = google_compute_instance.host.network_interface[0].access_config[0].nat_ip 13 | } 14 | -------------------------------------------------------------------------------- /terraform/aws/terraform.tfvars: -------------------------------------------------------------------------------- 1 | region = "us-east-2" 2 | profile = "terraform" 3 | shared_credentials_file = "~/.aws/credentials" 4 | public_key_name = "securityonion" 5 | public_key_path = "~/.ssh/securityonion.pub" 6 | private_key_path = "~/.ssh/securityonion" 7 | ip_whitelist = ["0.0.0.0/32"] #Change this to your public ip/32 8 | instance_type = "t3a.xlarge" 9 | auto_mirror = true 10 | ubuntu_hosts = 0 11 | windows_hosts = 0 12 | 13 | -------------------------------------------------------------------------------- /terraform/aws/outputs.tf: -------------------------------------------------------------------------------- 1 | output "Region" { 2 | value = var.region 3 | } 4 | 5 | output "securityonion_public_ips" { 6 | description = "Security Onion Public IP Address(es)" 7 | value = aws_instance.securityonion[*].public_ip 8 | } 9 | 10 | output "windows_public_ips" { 11 | description = "Windows Instance IP Address(es)" 12 | value = aws_instance.windows_instance[*].public_ip 13 | } 14 | 15 | output "ubuntu_public_ips" { 16 | description = "Ubuntu Instance IP Address(es)" 17 | value = aws_instance.ubuntu_instance[*].public_ip 18 | } 19 | 20 | 21 | -------------------------------------------------------------------------------- /terraform/gcp/ubuntu.tf: -------------------------------------------------------------------------------- 1 | resource "google_compute_instance" "host" { 2 | name = "host1" 3 | machine_type = "n1-standard-1" 4 | zone = "us-east1-b" 5 | tags = ["mirror"] 6 | boot_disk { 7 | initialize_params { 8 | image = "ubuntu-os-cloud/ubuntu-1604-lts" 9 | } 10 | } 11 | 12 | network_interface { 13 | subnetwork = "${google_compute_subnetwork.host_subnet.name}" 14 | access_config { 15 | // Ephemeral IP 16 | } 17 | } 18 | 19 | metadata = { 20 | sshKeys = "ubuntu:${file(var.public_key_path)}" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /terraform/gcp/variables.tf: -------------------------------------------------------------------------------- 1 | variable "region" {} 2 | variable "project" {} 3 | variable "shared_credentials_file" {} 4 | variable "host_vpc_name" {} 5 | variable "so_vpc_name" {} 6 | variable "so_subnet_cidr" {} 7 | variable "host_subnet_cidr" {} 8 | variable "ip_whitelist" {} 9 | variable "public_key_name" {} 10 | variable "public_key_path" {} 11 | variable "private_key_path" {} 12 | variable "profile" {} 13 | variable "so_username" {} 14 | variable "zone" {} 15 | variable "so_machine_type" {} 16 | variable "so_machine_name" {} 17 | variable "so_image_family" {} 18 | variable "so_image_project" {} 19 | variable "so_image_size" {} 20 | -------------------------------------------------------------------------------- /terraform/gcp/subnets.tf: -------------------------------------------------------------------------------- 1 | // Create Security Onion Subnet 2 | resource "google_compute_subnetwork" "so_subnet" { 3 | name = "securityonion-subnet" 4 | ip_cidr_range = "${var.so_subnet_cidr}" 5 | network = "${var.so_vpc_name}" 6 | depends_on = ["google_compute_network.so_vpc"] 7 | region = "${var.region}" 8 | } 9 | 10 | // Create host subnet 11 | resource "google_compute_subnetwork" "host_subnet" { 12 | name = "host--subnet" 13 | ip_cidr_range = "${var.host_subnet_cidr}" 14 | network = "${var.host_vpc_name}" 15 | depends_on = ["google_compute_network.host_vpc"] 16 | region = "${var.region}" 17 | } 18 | -------------------------------------------------------------------------------- /terraform/gcp/backend.tf: -------------------------------------------------------------------------------- 1 | // Backend service for relaying mirror packets to sensors 2 | resource "google_compute_region_backend_service" "backend" { 3 | name = "lb-backend" 4 | region = "us-east1" 5 | health_checks = ["${google_compute_health_check.hc.self_link}"] 6 | network = "${var.so_vpc_name}" 7 | backend { 8 | group = google_compute_instance_group.sensors.self_link 9 | } 10 | 11 | } 12 | resource "google_compute_health_check" "hc" { 13 | name = "check-lb-backend" 14 | check_interval_sec = 1 15 | timeout_sec = 1 16 | tcp_health_check { 17 | port = "80" 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /vxlan2pcap/README.md: -------------------------------------------------------------------------------- 1 | #### vxlan2pcap 2 | Decapsulate VXLAN-encapsulated PCAP 3 | 4 | vxlan2pcap 5 | 6 | #### Go 7 | ##### vxlan2pcap 8 | 9 | - This program will allow you to quickly and easily de-encapsulate a PCAP with VXLAN encapsulation. Simply download the executable (ensure it itself is executable), and run like so: 10 | 11 | ./vxlan2pcap srcPCAP dstPCAP 12 | 13 | #### Python 14 | ##### vxlan2pcap.py 15 | 16 | - Only use this script if you have to -- while it leverages all the great functionality of Scapy and its layers, it can be much slower than the Go version of this utility. 17 | -------------------------------------------------------------------------------- /terraform/gcp/terraform.tfvars: -------------------------------------------------------------------------------- 1 | project = "yourproject" 2 | host_vpc_name = "hosts" 3 | so_vpc_name = "securityonion" 4 | so_subnet_cidr = "172.16.163.0/24" 5 | host_subnet_cidr = "172.16.164.0/24" 6 | region = "us-east1" 7 | zone = "us-east1-b" 8 | profile = "terraform" 9 | shared_credentials_file = "yourcredentialsfile.json" 10 | public_key_name = "securityonion" 11 | public_key_path = "~/.ssh/securityonion.pub" 12 | private_key_path = "~/.ssh/securityonion" 13 | so_machine_type = "e2-standard-4" 14 | so_machine_name = "securityonion-gcp" 15 | so_image_family = "centos-7" 16 | so_image_project = "centos-cloud" 17 | so_image_size = "200" 18 | so_username = "onion" 19 | ip_whitelist = "0.0.0.0/32" #Change this to your public ip/32 20 | 21 | -------------------------------------------------------------------------------- /terraform/gcp/firewall.tf: -------------------------------------------------------------------------------- 1 | // Host VPC firewall configuration 2 | resource "google_compute_firewall" "host_firewall" { 3 | name = "${var.host_vpc_name}-firewall" 4 | network = "${google_compute_network.host_vpc.name}" 5 | 6 | allow { 7 | protocol = "tcp" 8 | ports = ["22"] 9 | } 10 | 11 | allow { 12 | protocol = "tcp" 13 | ports = ["443"] 14 | } 15 | 16 | source_ranges = [ "${var.ip_whitelist}" ] 17 | } 18 | 19 | // SO VPC firewall configuration 20 | resource "google_compute_firewall" "so_firewall" { 21 | name = "${var.so_vpc_name}-firewall" 22 | network = "${google_compute_network.so_vpc.name}" 23 | 24 | allow { 25 | protocol = "tcp" 26 | ports = ["0-65535"] 27 | } 28 | 29 | allow { 30 | protocol = "udp" 31 | ports = ["0-65535"] 32 | } 33 | 34 | // Allow all traffic to be mirrored 35 | source_ranges = [ "0.0.0.0/0" ] 36 | 37 | //source_ranges = [ "${var._subnet_cidr}", "${var.ip_whitelist}" ] 38 | } 39 | -------------------------------------------------------------------------------- /terraform/gcp/vpc.tf: -------------------------------------------------------------------------------- 1 | // Create Host VPC 2 | resource "google_compute_network" "host_vpc" { 3 | name = "${var.host_vpc_name}" 4 | auto_create_subnetworks = "false" 5 | } 6 | 7 | // Create SO VPC 8 | resource "google_compute_network" "so_vpc" { 9 | name = "${var.so_vpc_name}" 10 | auto_create_subnetworks = "false" 11 | } 12 | 13 | resource "google_compute_network_peering" "peering1" { 14 | depends_on = [ google_compute_network.host_vpc, google_compute_network.so_vpc ] 15 | name = "peering1" 16 | network = google_compute_network.host_vpc.self_link 17 | peer_network = google_compute_network.so_vpc.self_link 18 | } 19 | 20 | resource "google_compute_network_peering" "peering2" { 21 | depends_on = [ google_compute_network.host_vpc, google_compute_network.so_vpc ] 22 | name = "peering2" 23 | network = google_compute_network.so_vpc.self_link 24 | peer_network = google_compute_network.host_vpc.self_link 25 | } 26 | -------------------------------------------------------------------------------- /.github/workflows/contrib.yml: -------------------------------------------------------------------------------- 1 | name: contrib 2 | on: 3 | issue_comment: 4 | types: [created] 5 | pull_request_target: 6 | types: [opened,closed,synchronize] 7 | 8 | jobs: 9 | CLAssistant: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: "Contributor Check" 13 | if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' 14 | uses: cla-assistant/github-action@v2.1.3-beta 15 | env: 16 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 17 | PERSONAL_ACCESS_TOKEN : ${{ secrets.PERSONAL_ACCESS_TOKEN }} 18 | with: 19 | path-to-signatures: 'signatures_v1.json' 20 | path-to-document: 'https://securityonionsolutions.com/cla' 21 | allowlist: dependabot[bot],jertel,dougburks,TOoSmOotH,weslambert,defensivedepth,m0duspwnens 22 | remote-organization-name: Security-Onion-Solutions 23 | remote-repository-name: licensing 24 | 25 | -------------------------------------------------------------------------------- /terraform/aws/prep_so: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Install Terraform/AWS CLI 4 | echo "Installing pre-requisites..." 5 | echo "" 6 | sudo ./install-terraform-awscli.sh 7 | 8 | # Install jq 9 | [ -f /etc/lsb-release ] && apt install -y jq 10 | [ "$(uname)" == "Darwin" ] && brew install -y jq 11 | 12 | # Configure AWS 13 | echo 14 | echo "Configuring AWS CLI..." 15 | echo 16 | aws configure 17 | 18 | # Configure SSH Key 19 | echo 20 | echo "Configuring SSH key..." 21 | echo 22 | mkdir -p ~/.ssh 23 | ssh-keygen -b 2048 -f ~/.ssh/securityonion 24 | 25 | # Monitor host 26 | echo 27 | read -n1 -p "Would you like to configure an Ubuntu host to be monitored? [Y/N]" configureUbuntu 28 | case $configureUbuntu in 29 | y|Y) echo 30 | echo 31 | echo "Configuring Ubuntu host to be monitored..." 32 | sed -i 's/ubuntu_hosts = 0/ubuntu_hosts = 1/' terraform.tfvars 33 | echo 34 | ;; 35 | n|N) 36 | echo 37 | echo 38 | echo "Not configuring Ubuntu host..." 39 | echo 40 | ;; 41 | *) 42 | echo "Not a valid response!" 43 | exit 1 44 | ;; 45 | esac 46 | 47 | echo 48 | echo "Configuration complete! Please run the launch_so script to bring up your instance(s)" 49 | echo 50 | -------------------------------------------------------------------------------- /terraform/gcp/mirror.tf: -------------------------------------------------------------------------------- 1 | resource "google_compute_forwarding_rule" "default" { 2 | depends_on = [ google_compute_region_backend_service.backend ] 3 | name = "lb-forwarding-rule" 4 | provider = google-beta 5 | is_mirroring_collector = true 6 | ip_protocol = "TCP" 7 | region = "us-east1" 8 | load_balancing_scheme = "INTERNAL" 9 | backend_service = "${google_compute_region_backend_service.backend.self_link}" 10 | all_ports = true 11 | allow_global_access = true 12 | network = "${var.so_vpc_name}" 13 | subnetwork = "${google_compute_subnetwork.so_subnet.name}" 14 | } 15 | 16 | resource "google_compute_packet_mirroring" "mirror_policy" { 17 | provider = google-beta 18 | name = "securityonion-mirroring" 19 | description = "Mirror Policy for SO" 20 | network { 21 | url = google_compute_network.host_vpc.self_link 22 | } 23 | collector_ilb { 24 | url = google_compute_forwarding_rule.default.self_link 25 | } 26 | mirrored_resources { 27 | tags = ["mirror"] 28 | //instances { 29 | // url = google_compute_instance.host.self_link 30 | //} 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /terraform/aws/ubuntu.tf: -------------------------------------------------------------------------------- 1 | // This section is for the creation of Ubuntu hosts 2 | 3 | data "aws_ami" "latest_ubuntu" { 4 | 5 | most_recent = true 6 | owners = ["099720109477"] # Canonical 7 | 8 | filter { 9 | name = "name" 10 | values = ["ubuntu/images/hvm-ssd/ubuntu-focal-20.04-amd64-server-*"] 11 | } 12 | 13 | filter { 14 | name = "virtualization-type" 15 | values = ["hvm"] 16 | } 17 | 18 | } 19 | 20 | resource "aws_instance" "ubuntu_instance" { 21 | depends_on = [ null_resource.mirror_session_del_wait, aws_lambda_function.auto_mirror_lambda ] 22 | count = var.ubuntu_hosts != 0 ? var.ubuntu_hosts : 0 23 | instance_type = var.ubuntu_instance_type 24 | ami = data.aws_ami.latest_ubuntu.id != "" ? data.aws_ami.latest_ubuntu.id : var.ubuntu_instance_ami 25 | 26 | tags = var.auto_mirror ? { Name = "ubuntu-${count.index}", Mirror = "True" } : { Name = "ubuntu-${count.index}" } 27 | 28 | subnet_id = aws_subnet.default.id 29 | vpc_security_group_ids = [aws_security_group.securityonion.id] 30 | key_name = aws_key_pair.auth.key_name 31 | private_ip = "172.16.163.3${count.index}" 32 | root_block_device { 33 | delete_on_termination = true 34 | volume_size = 30 35 | } 36 | } 37 | 38 | -------------------------------------------------------------------------------- /terraform/aws/vpc.tf: -------------------------------------------------------------------------------- 1 | # Originally Written by: Jonathan Johnson 2 | # Updated by: Dustin Lee for Security Onion 3 | # Additions and updates by Wes Lambert for Security Onion and VPC Mirroring 4 | 5 | resource "aws_key_pair" "auth" { 6 | key_name = var.public_key_name 7 | public_key = file(var.public_key_path) 8 | } 9 | 10 | # Provide Region 11 | provider "aws" { 12 | region = var.region 13 | } 14 | 15 | # Inital VPC 16 | resource "aws_vpc" "terraform" { 17 | cidr_block = "172.16.0.0/16" 18 | tags = { 19 | Name = "SO Terraform VPC" 20 | } 21 | } 22 | 23 | # Internet Gateway creation 24 | resource "aws_internet_gateway" "default" { 25 | vpc_id = aws_vpc.terraform.id 26 | } 27 | 28 | # Route table to give VPC internet 29 | resource "aws_route" "internet_access" { 30 | route_table_id = aws_vpc.terraform.main_route_table_id 31 | destination_cidr_block = "0.0.0.0/0" 32 | gateway_id = aws_internet_gateway.default.id 33 | } 34 | 35 | # subnet creation 36 | resource "aws_subnet" "default" { 37 | vpc_id = aws_vpc.terraform.id 38 | cidr_block = "172.16.163.0/24" 39 | availability_zone = var.availability_zone 40 | map_public_ip_on_launch = true 41 | } 42 | 43 | resource "aws_vpc_dhcp_options" "default" { 44 | domain_name_servers = concat(var.external_dns_servers) 45 | } 46 | 47 | resource "aws_vpc_dhcp_options_association" "default" { 48 | vpc_id = aws_vpc.terraform.id 49 | dhcp_options_id = aws_vpc_dhcp_options.default.id 50 | } 51 | 52 | -------------------------------------------------------------------------------- /terraform/aws/windows.tf: -------------------------------------------------------------------------------- 1 | // This section is for the creation of Windows Server hosts 2 | 3 | data "aws_ami" "latest_windows" { 4 | 5 | most_recent = true 6 | owners = ["801119661308"] # Canonical 7 | 8 | filter { 9 | name = "name" 10 | values = ["Windows_Server-2019-English-Full-Base-*"] 11 | } 12 | 13 | filter { 14 | name = "virtualization-type" 15 | values = ["hvm"] 16 | } 17 | 18 | } 19 | 20 | resource "aws_instance" "windows_instance" { 21 | depends_on = [ null_resource.mirror_session_del_wait, aws_lambda_function.auto_mirror_lambda ] 22 | count = var.windows_hosts != 0 ? var.windows_hosts : 0 23 | instance_type = var.windows_instance_type 24 | ami = data.aws_ami.latest_windows.id != "" ? data.aws_ami.latest_windows.id : var.windows_instance_ami 25 | 26 | tags = var.auto_mirror ? { Name = "windows-${count.index}", Mirror = "True" } : { Name = "windows-${count.index}" } 27 | 28 | subnet_id = aws_subnet.default.id 29 | vpc_security_group_ids = [aws_security_group.securityonion.id] 30 | key_name = aws_key_pair.auth.key_name 31 | private_ip = "172.16.163.4${count.index}" 32 | root_block_device { 33 | delete_on_termination = true 34 | volume_size = 60 35 | } 36 | } 37 | 38 | resource "aws_security_group_rule" "example" { 39 | count = var.windows_hosts >= 1 ? 1 : 0 40 | type = "ingress" 41 | from_port = 3389 42 | to_port = 3389 43 | protocol = "tcp" 44 | cidr_blocks = var.ip_whitelist 45 | security_group_id = aws_security_group.securityonion.id 46 | } 47 | 48 | -------------------------------------------------------------------------------- /terraform/gcp/sensor.tf: -------------------------------------------------------------------------------- 1 | 2 | data "google_compute_image" "so_image" { 3 | family = "${var.so_image_family}" 4 | project = "${var.so_image_project}" 5 | } 6 | 7 | resource "google_compute_instance" "sensor" { 8 | name = "${var.so_machine_name}" 9 | machine_type = "${var.so_machine_type}" 10 | zone = "${var.zone}" 11 | tags = ["securityonion-sensor"] 12 | boot_disk { 13 | initialize_params { 14 | image = data.google_compute_image.so_image.self_link 15 | size = "${var.so_image_size}" 16 | type = "pd-ssd" 17 | } 18 | } 19 | 20 | network_interface { 21 | subnetwork = "${google_compute_subnetwork.host_subnet.name}" 22 | access_config { 23 | // Ephemeral IP 24 | } 25 | } 26 | 27 | network_interface { 28 | subnetwork = "${google_compute_subnetwork.so_subnet.name}" 29 | } 30 | 31 | metadata = { 32 | sshKeys = "${var.so_username}:${file(var.public_key_path)}" 33 | } 34 | } 35 | 36 | resource "null_resource" "configure_so" { 37 | depends_on = [ google_compute_instance.sensor ] 38 | provisioner "remote-exec" { 39 | inline = [ 40 | "sudo yum update -y", 41 | "sudo yum install -y git", 42 | "git clone https://github.com/security-onion-solutions/securityonion", 43 | "sudo sed -i 's/#plugins=.*/plugins=keyfile/' /etc/NetworkManager/NetworkManager.conf", 44 | "sudo systemctl restart NetworkManager", 45 | ] 46 | connection { 47 | type = "ssh" 48 | user = "${var.so_username}" 49 | host = google_compute_instance.sensor.network_interface[0].access_config[0].nat_ip 50 | private_key = file(var.private_key_path) 51 | } 52 | } 53 | 54 | } 55 | 56 | resource "google_compute_instance_group" "sensors" { 57 | depends_on = [ google_compute_instance.sensor ] 58 | name = "securityonion-sensors" 59 | description = "Security Onion instance group" 60 | zone = "${var.zone}" 61 | instances = [ 62 | google_compute_instance.sensor.self_link 63 | ] 64 | } 65 | 66 | 67 | -------------------------------------------------------------------------------- /terraform/gcp/install-terraform.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Originally the Mordor script: install-terraform-packer.sh 4 | # Original Mordor script description: Install Terraform for Linux or Mac 5 | # Original Author: Roberto Rodriguez (@Cyb3rWard0g) 6 | # Updated by: Dustin Lee and Wes Lambert 7 | # License: GPL-3.0 8 | 9 | SYSTEM_KERNEL="$(uname -s)" 10 | 11 | 12 | [ "$SYSTEM_KERNEL" == "Linux" ] && apt-get update 13 | 14 | if ! [ -x "$(command -v wget)" ]; then 15 | echo "[TERRAFORM-INFO] Installing Wget for $SYSTEM_KERNEL" 16 | if [ "$SYSTEM_KERNEL" == "Linux" ]; then 17 | apt-get install -y --no-install-recommends wget 18 | elif [ "$SYSTEM_KERNEL" == "Darwin" ]; then 19 | brew install wget 20 | fi 21 | fi 22 | 23 | if ! [ -x "$(command -v unzip)" ]; then 24 | echo "[TERRAFORM-INFO] Installing Unzip for $SYSTEM_KERNEL" 25 | if [ "$SYSTEM_KERNEL" == "Linux" ]; then 26 | apt-get install -y --no-install-recommends unzip 27 | elif [ "$SYSTEM_KERNEL" == "Darwin" ]; then 28 | brew install unzip 29 | fi 30 | fi 31 | 32 | if ! [ -x "$(command -v pip3)" ]; then 33 | echo "[TERRAFORM-INFO] Installing pip3 for $SYSTEM_KERNEL" 34 | if [ "$SYSTEM_KERNEL" == "Linux" ]; then 35 | apt-get install -y --no-install-recommends python3-pip 36 | python3 -m pip install -U setuptools 37 | elif [ "$SYSTEM_KERNEL" == "Darwin" ]; then 38 | brew install pip3 39 | fi 40 | fi 41 | 42 | TERRAFORM_VERSION=0.12.2 43 | 44 | if [ "$SYSTEM_KERNEL" == "Linux" ]; then 45 | OPERATING_SYSTEM=linux 46 | elif [ "$SYSTEM_KERNEL" == "Darwin" ]; then 47 | OPERATING_SYSTEM=darwin 48 | fi 49 | 50 | TERRAFORM_DOWNLOAD=https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_${OPERATING_SYSTEM}_amd64.zip 51 | 52 | echo "[TERRAFORM-INFO] Installing Terraform & Packer for $SYSTEM_KERNEL" 53 | 54 | if ! [ -x "$(command -v /usr/local/bin/terraform)" ]; then 55 | echo "[TERRAFORM-INFO] Installing Terraform.." 56 | wget $TERRAFORM_DOWNLOAD -P /tmp/ 57 | unzip -j /tmp/*.zip -d /usr/local/bin/ 58 | rm /tmp/*.zip 59 | fi 60 | -------------------------------------------------------------------------------- /vxlan2pcap/python/vxlan2pcap.py: -------------------------------------------------------------------------------- 1 | # Parse VXLAN-encapsulated packets into new PCAP 2 | # 3 | # Copyright 2014,2015,2016,2017,2018,2019,2020 Security Onion Solutions, LLC 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | # 18 | # Pre-reqs: 19 | # pip3 install scapy 20 | # Example VXLAN PCAP: https://github.com/the-tcpdump-group/tcpdump/raw/master/tests/vxlan.pcap 21 | 22 | import sys, getopt 23 | from scapy.all import * 24 | 25 | def write(pkt): 26 | wrpcap(outputfile, pkt, append=True) 27 | 28 | def main(argv): 29 | global outputfile 30 | inputfile = '' 31 | outputfile = '' 32 | try: 33 | opts, args = getopt.getopt(argv,"hi:o:",["ifile=","ofile="]) 34 | except getopt.GetoptError: 35 | print ('test.py -i -o ') 36 | sys.exit(2) 37 | for opt, arg in opts: 38 | if opt == '-h': 39 | print ('test.py -i -o ') 40 | sys.exit() 41 | elif opt in ("-i", "--ifile"): 42 | inputfile = arg 43 | elif opt in ("-o", "--ofile"): 44 | outputfile = arg 45 | 46 | print("\nConverting packets from " + inputfile + " into " + outputfile + "...\n") 47 | 48 | # Read in packets (use PcapReader so we don't have to load large PCAPs in memory) 49 | with PcapReader(inputfile) as pkts: 50 | for pkt in pkts: 51 | # Write VXLAN payload if match 52 | if pkt.haslayer(VXLAN): 53 | try: 54 | write(pkt[VXLAN].payload) 55 | except: 56 | print("VXLAN encapsulated packet not found.") 57 | # Otherwise, just write the packet 58 | else: 59 | print("No VXLAN packet to convert...writing original packet.") 60 | try: 61 | write(pkt) 62 | except: 63 | print("Couldn't write packet!") 64 | 65 | print("Done!") 66 | if __name__ == "__main__": 67 | main(sys.argv[1:]) 68 | -------------------------------------------------------------------------------- /terraform/gcp/README.md: -------------------------------------------------------------------------------- 1 | # Security Onion in the Cloud 2 | # DISCLAIMER: The following content was developed for usage with Security Onion 16.04 and has not yet been updated for Security Onion 2. 3 | 4 | **NOTE: The Security Onion Google Image and associated scripts are still in testing, and are NOT recommended for production use.** 5 | 6 | The following components are currently supported and are in testing: 7 | 8 | - Security Onion Terraform Configuration 9 | 10 | ### Configuring the Security Onion Instance and Packet Mirroring with Terraform 11 | 12 | By using Terraform, one can quickly spin up Security Onion in Google Cloud, creating all the necessary components to faciliate packet mirroring. 13 | 14 | #### Clone repo 15 | `git clone https://github.com/Security-Onion-Solutions/securityonion-cloud 16 | && cd securityonion-cloud/terraform/gcp` 17 | 18 | #### Install Terraform 19 | ##### Linux (recommended Ubuntu 18.04 or higher) or Mac (as root or with sudo privilieges): 20 | `pip3 --upgrade pip` 21 | `./install-terraform.sh` 22 | ##### Windows 23 | https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-windows.html#cliv2-windows-prereq 24 | https://www.terraform.io/downloads.html 25 | https://stackoverflow.com/questions/1618280/where-can-i-set-path-to-make-exe-on-windows 26 | 27 | #### Configure GCloud details 28 | See the following for more details: 29 | https://cloud.google.com/sdk/docs/quickstart-debian-ubuntu 30 | 31 | #### Create public/private keypair for use with instance 32 | `ssh-keygen -b 2048 -f ~/.ssh/securityonion` 33 | 34 | #### Get your external IP (to allow access to your GCloud instance) 35 | `dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'` 36 | 37 | #### Modify config file with external IP for whitelist, and other details (like GCloud credentials file) 38 | Edit `terraform.tfvars` with external IP/netmask (gathered above) for whitelist 39 | 40 | `Ex. "192.168.1.1/32"` 41 | 42 | #### Initialize Terraform 43 | `terraform init` 44 | 45 | #### Build VPC Infrastructure and Instance 46 | `terraform apply --auto-approve` 47 | 48 | The output from this command should provide you with the public IP address of your GCloud instance(s). 49 | 50 | #### SSH into instance 51 | `ssh -i ~/.ssh/securityonion onion@$instanceip` 52 | 53 | #### Run Setup 54 | 55 | `cd securityonion` 56 | `sudo ./so-setup-network` 57 | 58 | Follow the prompts in setup. When asked to choose the method for web access, choose `OTHER` and provide a name that can be mapped via a hosts file or resolvable via DNS. 59 | 60 | ##### Tear it down 61 | The instance and VPC configuration can quickly be destroyed with the following: 62 | `terraform destroy --auto-approve` 63 | -------------------------------------------------------------------------------- /terraform/aws/variables.tf: -------------------------------------------------------------------------------- 1 | variable "region" { 2 | default = "us-east-1" 3 | } 4 | 5 | variable "onions" { 6 | default = 1 7 | } 8 | 9 | variable "onionuser" { 10 | default = "analyst" 11 | } 12 | 13 | variable "onionpass" { 14 | type = list(string) 15 | default = [""] 16 | } 17 | 18 | variable "profile" { 19 | default = "terraform" 20 | } 21 | 22 | variable "availability_zone" { 23 | description = "https://www.terraform.io/docs/providers/aws/d/availability_zone.html" 24 | default = "" 25 | } 26 | 27 | variable "shared_credentials_file" { 28 | description = "Path to your AWS credentials file" 29 | type = string 30 | default = "~/.aws/credentials" 31 | } 32 | 33 | variable "public_key_name" { 34 | description = "A name for AWS Keypair to use to auth to authenticate to Security Onion." 35 | default = "securityonion" 36 | } 37 | 38 | variable "public_key_path" { 39 | description = "Path to the public key to be loaded into the Security Onion authorized_keys file" 40 | type = string 41 | default = "~/.ssh/securityonion.pub" 42 | } 43 | 44 | variable "private_key_path" { 45 | description = "Path to the private key to use to authenticate to Security Onion." 46 | type = string 47 | default = "~/.ssh/securityonion" 48 | } 49 | 50 | variable "ip_whitelist" { 51 | description = "A list of CIDRs that will be allowed to access the EC2 instances" 52 | type = list(string) 53 | default = [""] 54 | } 55 | 56 | variable "external_dns_servers" { 57 | description = "Configure lab to allow external DNS resolution" 58 | type = list(string) 59 | default = ["8.8.8.8"] 60 | } 61 | 62 | variable "ami" { 63 | type = string 64 | default = "" 65 | } 66 | 67 | variable "soversion" { 68 | type = string 69 | default = "2.*" 70 | } 71 | 72 | variable "instance_type" { 73 | type = string 74 | default = "t3.medium" 75 | } 76 | 77 | variable "auto_mirror" { 78 | description = "If set to true, use 3CS AutoMirror to create sessions for eligible instances" 79 | type = bool 80 | } 81 | 82 | 83 | variable "ubuntu_instance_ami" { 84 | type = string 85 | default = "ami-03ffa9b61e8d2cfda" 86 | } 87 | 88 | variable "ubuntu_instance_type" { 89 | type = string 90 | default = "t3.small" 91 | } 92 | 93 | variable "ubuntu_hosts" { 94 | default = 0 95 | } 96 | 97 | variable "windows_instance_ami" { 98 | type = string 99 | default = "ami-08db69d5de9dc9245" 100 | } 101 | 102 | variable "windows_instance_type" { 103 | type = string 104 | default = "t3.small" 105 | } 106 | 107 | variable "windows_hosts" { 108 | default = 0 109 | } 110 | 111 | -------------------------------------------------------------------------------- /terraform/aws/install-terraform-awscli.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Originally the Mordor script: install-terraform-packer.sh 4 | # Original Mordor script description: Install Terraform for Linux or Mac 5 | # Original Author: Roberto Rodriguez (@Cyb3rWard0g) 6 | # Updated by: Dustin Lee and Wes Lambert 7 | # License: GPL-3.0 8 | 9 | SYSTEM_KERNEL="$(uname -s)" 10 | 11 | 12 | [ "$SYSTEM_KERNEL" == "Linux" ] && apt-get update 13 | 14 | if ! [ -x "$(command -v wget)" ]; then 15 | echo "[TERRAFORM-INFO] Installing Wget for $SYSTEM_KERNEL" 16 | if [ "$SYSTEM_KERNEL" == "Linux" ]; then 17 | apt-get install -y --no-install-recommends wget 18 | elif [ "$SYSTEM_KERNEL" == "Darwin" ]; then 19 | brew install wget 20 | fi 21 | fi 22 | 23 | if ! [ -x "$(command -v unzip)" ]; then 24 | echo "[TERRAFORM-INFO] Installing Unzip for $SYSTEM_KERNEL" 25 | if [ "$SYSTEM_KERNEL" == "Linux" ]; then 26 | apt-get install -y --no-install-recommends unzip 27 | elif [ "$SYSTEM_KERNEL" == "Darwin" ]; then 28 | brew install unzip 29 | fi 30 | fi 31 | 32 | if ! [ -x "$(command -v pip3)" ]; then 33 | echo "[TERRAFORM-INFO] Installing pip3 for $SYSTEM_KERNEL" 34 | if [ "$SYSTEM_KERNEL" == "Linux" ]; then 35 | apt-get install -y --no-install-recommends python3-pip 36 | python3 -m pip install -U setuptools 37 | elif [ "$SYSTEM_KERNEL" == "Darwin" ]; then 38 | brew install pip3 39 | fi 40 | fi 41 | 42 | if ! [ -x "$(command -v awscli)" ]; then 43 | if [ -x "$(command -v python3)" ]; then 44 | echo "[TERRAFORM-INFO] Installing awscli for $SYSTEM_KERNEL via pip" 45 | python3 -m pip install -U awscli 46 | else 47 | echo "[TERRAFORM-INFO] python3 is needed for this step.." 48 | exit 1 49 | fi 50 | fi 51 | 52 | if ! [ -x "$(command -v awsebcli)" ]; then 53 | if [ -x "$(command -v python3)" ]; then 54 | echo "[TERRAFORM-INFO] Installing awsebcli for $SYSTEM_KERNEL via pip" 55 | python3 -m pip install -U awsebcli 56 | else 57 | echo "[TERRAFORM-INFO] python3 is needed for this step.." 58 | exit 1 59 | fi 60 | fi 61 | 62 | TERRAFORM_VERSION=0.12.2 63 | 64 | if [ "$SYSTEM_KERNEL" == "Linux" ]; then 65 | OPERATING_SYSTEM=linux 66 | elif [ "$SYSTEM_KERNEL" == "Darwin" ]; then 67 | OPERATING_SYSTEM=darwin 68 | fi 69 | 70 | TERRAFORM_DOWNLOAD=https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_${OPERATING_SYSTEM}_amd64.zip 71 | 72 | echo "[TERRAFORM-INFO] Installing Terraform & Packer for $SYSTEM_KERNEL" 73 | 74 | if ! [ -x "$(command -v /usr/local/bin/terraform)" ]; then 75 | echo "[TERRAFORM-INFO] Installing Terraform.." 76 | wget $TERRAFORM_DOWNLOAD -P /tmp/ 77 | unzip -j /tmp/*.zip -d /usr/local/bin/ 78 | rm /tmp/*.zip 79 | fi 80 | -------------------------------------------------------------------------------- /vxlan2pcap/go/src/vxlan2pcap.go: -------------------------------------------------------------------------------- 1 | // Parse VXLAN-encapsulated packets into new PCAP 2 | // 3 | // Copyright 2014,2015,2016,2017,2018,2019,2020 Security Onion Solutions, LLC 4 | // 5 | // This program is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, either version 3 of the License, or 8 | // (at your option) any later version. 9 | // 10 | // This program is distributed in the hope that it will be useful, 11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | // GNU General Public License for more details. 14 | // 15 | // You should have received a copy of the GNU General Public License 16 | // along with this program. If not, see . 17 | 18 | package main 19 | import ( 20 | "os" 21 | "fmt" 22 | "github.com/google/gopacket" 23 | "github.com/google/gopacket/pcap" 24 | "github.com/google/gopacket/pcapgo" 25 | "github.com/google/gopacket/layers" 26 | ) 27 | var ( 28 | handle *pcap.Handle 29 | err error 30 | snapshotLen uint32 = 65535 31 | ) 32 | func main() { 33 | if len(os.Args) > 2 { 34 | srcPCAP := os.Args[1] 35 | dstPCAP := os.Args[2] 36 | 37 | // Get output file ready 38 | f, _ := os.Create(dstPCAP) 39 | w := pcapgo.NewWriter(f) 40 | w.WriteFileHeader(snapshotLen, layers.LinkTypeEthernet) 41 | defer f.Close() 42 | 43 | // Read source file 44 | handle, err = pcap.OpenOffline(srcPCAP) 45 | defer handle.Close() 46 | packetSource := gopacket.NewPacketSource(handle, handle.LinkType()) 47 | packetSource.DecodeOptions.Lazy = true 48 | packetSource.DecodeOptions.NoCopy = true 49 | for packet := range packetSource.Packets() { 50 | vxlan := packet.Layer(layers.LayerTypeVXLAN) 51 | if vxlan != nil { 52 | vxlan, _ := vxlan.(*layers.VXLAN) 53 | if vxlan.Payload != nil && len(vxlan.Payload) > 0 { 54 | 55 | // Define our payload 56 | payload := vxlan.Payload 57 | 58 | // Create new packet from our payload 59 | depacket := gopacket.NewPacket(payload, layers.LayerTypeEthernet, gopacket.Default) 60 | depacket.Metadata().Timestamp = packet.Metadata().Timestamp 61 | depacket.Metadata().CaptureLength = len(payload) 62 | depacket.Metadata().Length = len(payload) 63 | 64 | // Panic at the disco if we see errors 65 | if err != nil { 66 | panic(err) 67 | } 68 | 69 | // Write previously encapped packet 70 | w.WritePacket(depacket.Metadata().CaptureInfo, depacket.Data()) 71 | } 72 | } else { 73 | // Write non-encapped packet 74 | w.WritePacket(packet.Metadata().CaptureInfo, packet.Data()) 75 | } 76 | } 77 | } else { 78 | fmt.Println("\nSource/destination PCAP file not provided!\n") 79 | fmt.Println("Please re-run command like so:\n") 80 | fmt.Println("./vxlan2pcap ec2.describeInstances(params).promise() 22 | .then(data => ec2.describeInstances(altParams).promise() 23 | .then(altData => ec2.describeTrafficMirrorTargets().promise() 24 | .then(mirrTargetData => generateMirrorFilter() 25 | .then(mirrFilterData => { 26 | 27 | var _sessionInfo = sessionInfo.TrafficMirrorSessions; 28 | var sessionCount = _sessionInfo.length; 29 | var tasks = []; 30 | var netIds = []; 31 | var instIds = []; 32 | var mirrFilters = []; 33 | var mirrTargets = []; 34 | var usedSessionInfo = null; 35 | var masterMirrTarget = null; 36 | var masterMirrFilter = null; 37 | 38 | data.Reservations = data.Reservations.concat(altData.Reservations); 39 | 40 | try { 41 | usedSessionInfo = _sessionInfo 42 | .map(sess => { 43 | return { 44 | NetworkInterfaceId: sess.NetworkInterfaceId, 45 | TrafficMirrorTargetId: sess.TrafficMirrorTargetId, 46 | TrafficMirrorFilterId: sess.TrafficMirrorFilterId, 47 | SessionNumber: sess.SessionNumber 48 | } 49 | }); 50 | } catch (err) { 51 | usedSessionInfo = [] 52 | } 53 | 54 | var targetCountMap = []; 55 | 56 | var count = 0; 57 | 58 | mirrTargetData.TrafficMirrorTargets.forEach(x => { targetCountMap[count++] = { TrafficMirrorTargetId: x.TrafficMirrorTargetId, count: 0 } }); 59 | 60 | usedSessionInfo.forEach(x => { 61 | var index = targetCountMap.findIndex(y => y.TrafficMirrorTargetId == x.TrafficMirrorTargetId); 62 | targetCountMap[index].count++; 63 | }); 64 | 65 | if (mirrTargetData.TrafficMirrorTargets && mirrTargetData.TrafficMirrorTargets.length > 0) { 66 | masterMirrTarget = targetCountMap.reduce(function (prev, current) { 67 | return (prev.count < current.count) ? prev : current 68 | }).TrafficMirrorTargetId; 69 | } 70 | 71 | if (mirrFilterData.TrafficMirrorFilters && mirrFilterData.TrafficMirrorFilters.length > 0) 72 | masterMirrFilter = mirrFilterData 73 | .TrafficMirrorFilters[mirrFilterData.TrafficMirrorFilters.length - 1].TrafficMirrorFilterId; 74 | 75 | data 76 | .Reservations.forEach(res => 77 | res.Instances.forEach(inst => { 78 | var target = masterMirrTarget; 79 | 80 | console.log('\n------------\n', targetCountMap, '\n------------\n'); 81 | 82 | 83 | if (mirrTargetData.TrafficMirrorTargets && mirrTargetData.TrafficMirrorTargets.length > 0) { 84 | masterMirrTarget = targetCountMap.reduce(function (prev, current) { 85 | return (prev.count < current.count) ? prev : current 86 | }).TrafficMirrorTargetId; 87 | } 88 | 89 | var filter = masterMirrFilter; 90 | 91 | if (inst.Tags.map(x => x.Key.toLowerCase()).includes('mirror-target')) { 92 | target = inst 93 | .Tags[inst.Tags.map(x => x.Key.toLowerCase()).indexOf('mirror-target')] 94 | .Value; 95 | } 96 | 97 | if (inst.Tags.map(x => x.Key.toLowerCase()).includes('mirror-filter')) 98 | filter = inst 99 | .Tags[inst.Tags.map(x => x.Key.toLowerCase()).indexOf('mirror-filter')] 100 | .Value; 101 | 102 | if (inst.NetworkInterfaces != null && 103 | inst.NetworkInterfaces.length > 0 && 104 | usedSessionInfo.filter(x => x.NetworkInterfaceId == inst.NetworkInterfaces[0].NetworkInterfaceId).length < 3 && 105 | !usedSessionInfo.find(x => 106 | x.TrafficMirrorTargetId == target && 107 | x.TrafficMirrorFilterId == filter && 108 | x.NetworkInterfaceId == inst.NetworkInterfaces[0].NetworkInterfaceId 109 | ) && 110 | !(usedSessionInfo.find(x => x.NetworkInterfaceId == inst.NetworkInterfaces[0].NetworkInterfaceId) && !inst.Tags.map(x => x.Key.toLowerCase()).includes('mirror-target')) 111 | ) { 112 | var index = targetCountMap.findIndex(y => y.TrafficMirrorTargetId == masterMirrTarget); 113 | targetCountMap[index].count++; 114 | mirrTargets.push(target); 115 | mirrFilters.push(filter); 116 | instIds.push(inst.InstanceId); 117 | netIds.push(inst.NetworkInterfaces[0].NetworkInterfaceId); 118 | } 119 | }) 120 | ); 121 | netIds.forEach((netId, index) => { 122 | 123 | if (mirrFilters[index] != null && mirrTargets[index] != null) 124 | tasks.push(new Promise( 125 | function (resolve, reject) { 126 | var sessionNumber = calculateSessionNumber(usedSessionInfo, netId); 127 | if (sessionNumber == null) 128 | reject(`Interface ${netId} already has 3 sessions`); 129 | var _params = { 130 | NetworkInterfaceId: netId, 131 | SessionNumber: sessionNumber, 132 | TrafficMirrorFilterId: mirrFilters[index], 133 | TrafficMirrorTargetId: mirrTargets[index], 134 | Description: "Created by AutoMirror", 135 | TagSpecifications: [{ 136 | ResourceType: "traffic-mirror-session", 137 | Tags: [{ 138 | Key: 'Name', 139 | Value: `${instIds[index]}` 140 | }] 141 | }] 142 | } 143 | 144 | usedSessionInfo.push({ 145 | TrafficMirrorFilterId: mirrFilters[index], 146 | TrafficMirrorTargetId: mirrTargets[index], 147 | NetworkInterfaceId: netId, 148 | SessionNumber: sessionNumber 149 | }); 150 | ec2.createTrafficMirrorSession(_params, function (_err, _data) { 151 | if (_err) { 152 | console.log(JSON.stringify(_err, null, 2)); 153 | reject(); 154 | } else { 155 | resolve(_data); 156 | } 157 | }); 158 | } 159 | )) 160 | }); 161 | return Promise.all(tasks).then((res) => { 162 | var ret = { 163 | results: res, 164 | MirrorSessionsCount: sessionCount + res.length 165 | } 166 | console.log(JSON.stringify(ret, null, 2)); 167 | }); 168 | }) 169 | ) 170 | ) 171 | ) 172 | ) 173 | } 174 | 175 | function calculateSessionNumber(arr, source) { 176 | if (arr.length == 0) return 1; 177 | arr = arr.sort((a, b) => { 178 | return a.SessionNumber > b.SessionNumber 179 | }); 180 | arr = arr.filter(x => x.NetworkInterfaceId == source); 181 | if (arr.length > 0 && arr.length < 3) 182 | return arr.pop().SessionNumber + 1; 183 | //.slice(-1) 184 | else if (arr.length == 0) return 1; 185 | else return null; 186 | } 187 | 188 | async function generateMirrorFilter() { 189 | 190 | var mirrFilterParams = { 191 | Description: 'Created by AutoMirror', 192 | TagSpecifications: [{ 193 | ResourceType: "traffic-mirror-filter", 194 | Tags: [{ 195 | Key: 'Name', 196 | Value: 'AutoMirror-AllTraffic' 197 | }] 198 | }] 199 | }; 200 | 201 | return await ec2.describeTrafficMirrorFilters().promise() 202 | .then(data => { 203 | return new Promise(async (resolve, reject) => { 204 | var callback = (err, data) => { 205 | if (err) { 206 | console.log(JSON.stringify(err, null, 2)); 207 | reject(err); 208 | } 209 | }; 210 | 211 | if (data.TrafficMirrorFilters.length == 0) { 212 | await ec2.createTrafficMirrorFilter(mirrFilterParams).promise() 213 | .then(trafficMirrorFilterData => 214 | ec2.createTrafficMirrorFilterRule({ 215 | DestinationCidrBlock: '0.0.0.0/0', 216 | RuleAction: 'accept', 217 | RuleNumber: 100, 218 | SourceCidrBlock: '0.0.0.0/0', 219 | TrafficDirection: 'ingress', 220 | TrafficMirrorFilterId: trafficMirrorFilterData.TrafficMirrorFilter.TrafficMirrorFilterId 221 | }, callback).promise() 222 | .then( 223 | ec2.createTrafficMirrorFilterRule({ 224 | DestinationCidrBlock: '0.0.0.0/0', 225 | RuleAction: 'accept', 226 | RuleNumber: 100, 227 | SourceCidrBlock: '0.0.0.0/0', 228 | TrafficDirection: 'egress', 229 | TrafficMirrorFilterId: trafficMirrorFilterData.TrafficMirrorFilter.TrafficMirrorFilterId 230 | }, callback).promise() 231 | .then(() => { 232 | data.TrafficMirrorFilters.push({ TrafficMirrorFilterId: trafficMirrorFilterData.TrafficMirrorFilter.TrafficMirrorFilterId }); 233 | resolve(data); 234 | }) 235 | ) 236 | ) 237 | } 238 | else resolve(data) 239 | } 240 | ) 241 | }) 242 | } 243 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /terraform/aws/AutoMirror/LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------