├── _config.yml ├── IKEv2_enable_example.png ├── conf ├── ipsec.secrets ├── strongswan.conf ├── iptables ├── ipsec.conf.template ├── eap-radius.conf.template └── supervisord.conf ├── init.sh ├── scripts └── vpn ├── Dockerfile ├── onekey_run_vpnserver.sh ├── README.md └── LICENSE /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-cayman -------------------------------------------------------------------------------- /IKEv2_enable_example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/product/alpine-ikev2-vpn/master/IKEv2_enable_example.png -------------------------------------------------------------------------------- /conf/ipsec.secrets: -------------------------------------------------------------------------------- 1 | : RSA server.pem 2 | : PSK "iloveworld" 3 | : XAUTH "iloveworldPass" 4 | testUserOne %any : EAP "testOnePass" 5 | -------------------------------------------------------------------------------- /conf/strongswan.conf: -------------------------------------------------------------------------------- 1 | charon { 2 | i_dont_care_about_security_and_use_aggressive_mode_psk = yes 3 | load_modular = yes 4 | duplicheck.enable = no 5 | threads = 16 6 | compress = yes 7 | plugins { 8 | include strongswan.d/charon/*.conf 9 | } 10 | dns1 = 8.8.8.8 11 | dns2 = 114.114.114.114 12 | nbns1 = 8.8.8.8 13 | nbns2 = 8.8.4.4 14 | } 15 | include strongswan.d/*.conf -------------------------------------------------------------------------------- /conf/iptables: -------------------------------------------------------------------------------- 1 | *mangle 2 | :PREROUTING ACCEPT [35404:24997929] 3 | :INPUT ACCEPT [0:0] 4 | :FORWARD ACCEPT [0:0] 5 | :OUTPUT ACCEPT [0:0] 6 | :POSTROUTING ACCEPT [0:0] 7 | -A FORWARD -s 10.28.0.0/24 -o eth0 -p tcp -m tcp --tcp-flags SYN,RST SYN -m tcpmss --mss 1361:1536 -j TCPMSS --set-mss 1360 8 | COMMIT 9 | *filter 10 | :INPUT ACCEPT [0:0] 11 | :FORWARD ACCEPT [0:0] 12 | :OUTPUT ACCEPT [342:64390] 13 | -A INPUT -m state --state RELATED,ESTABLISHED -j ACCEPT 14 | -A INPUT -p icmp -j ACCEPT 15 | -A INPUT -i lo -j ACCEPT 16 | -A INPUT -i eth0 -p esp -j ACCEPT 17 | -A INPUT -i eth0 -p udp -m udp --dport 500 -j ACCEPT 18 | -A INPUT -i eth0 -p udp -m udp --dport 4500 -j ACCEPT 19 | -A INPUT -j REJECT --reject-with icmp-host-prohibited 20 | # 21 | -A FORWARD -m state --state RELATED,ESTABLISHED -j ACCEPT 22 | -A FORWARD -s 10.28.0.0/24 -j ACCEPT 23 | -A FORWARD -j REJECT --reject-with icmp-host-prohibited 24 | COMMIT 25 | *nat 26 | :PREROUTING ACCEPT [24:10065] 27 | :INPUT ACCEPT [5:241] 28 | :OUTPUT ACCEPT [18:1422] 29 | :POSTROUTING ACCEPT [18:1422] 30 | -A POSTROUTING -s 10.28.0.0/24 -o eth0 -j MASQUERADE 31 | COMMIT 32 | -------------------------------------------------------------------------------- /conf/ipsec.conf.template: -------------------------------------------------------------------------------- 1 | config setup 2 | uniqueids=never 3 | 4 | conn %default 5 | ikelifetime=60m 6 | keylife=20m 7 | rekeymargin=3m 8 | rekey=no 9 | keyingtries=1 10 | keyexchange=ike 11 | leftsubnet=0.0.0.0/0 12 | right=%any 13 | rightsourceip=10.28.0.0/24 14 | dpdaction=clear 15 | dpddelay=300s 16 | dpdtimeout=1h 17 | 18 | conn Windows7-os+ 19 | keyexchange=ikev2 20 | auto=add 21 | leftauth=pubkey 22 | leftcert=server.cert.pem 23 | rightauth=eap-mschapv2 24 | rightsendcert=never 25 | eap_identity=%identity 26 | compress=yes 27 | 28 | conn IOS_Mac_IKEv2 29 | keyexchange=ikev2 30 | ike=aes256-sha256-modp2048,3des-sha1-modp2048! 31 | esp=aes256-sha256,3des-sha1! 32 | rekey=no 33 | left=%defaultroute 34 | leftid=$HOST_IP 35 | leftsendcert=always 36 | leftsubnet=0.0.0.0/0 37 | leftcert=server.cert.pem 38 | right=%any 39 | rightauth=$EAP_TYPE 40 | rightsourceip=10.28.0.0/24 41 | rightsendcert=never 42 | eap_identity=%any 43 | dpdaction=clear 44 | fragmentation=yes 45 | auto=add 46 | -------------------------------------------------------------------------------- /init.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | # Preload iptables,Rule lost when preventing restart of container! 4 | iptables-restore < /etc/sysconfig/iptables 5 | 6 | # Repair gcp container restart, can not access google family bucket(Disable pmtu discovery!) 7 | sysctl -w net.ipv4.ip_forward=1 8 | sysctl -w net.ipv4.ip_no_pmtu_disc=1 9 | 10 | # Setting eap-radius config info 11 | if [ -z "$ACCOUNTING" ]; then 12 | export ACCOUNTING=no 13 | fi 14 | 15 | if [ -z "$RADIUS_PORT" ]; then 16 | export RADIUS_PORT=1812 17 | fi 18 | 19 | if [ -z "$RADIUS_SERVER" ]; then 20 | export RADIUS_SERVER='' 21 | fi 22 | 23 | if [ -z "$RADIUS_SECRET" ]; then 24 | export RADIUS_SECRET='' 25 | fi 26 | 27 | envsubst ' 28 | ${ACCOUNTING} 29 | ${RADIUS_PORT} 30 | ${RADIUS_SERVER} 31 | ${RADIUS_SECRET} 32 | ' < eap-radius.conf.template > /usr/local/etc/strongswan.d/charon/eap-radius.conf 33 | 34 | # Setting eap auth type 35 | if [ -z "$EAP_TYPE" ]; then 36 | export EAP_TYPE='eap-mschapv2' 37 | fi 38 | 39 | if [ -z "$HOST_IP" ]; then 40 | export HOST_IP='0.0.0.0' 41 | fi 42 | 43 | envsubst ' 44 | ${EAP_TYPE} 45 | ${HOST_IP} 46 | ' < ipsec.conf.template > /usr/local/etc/ipsec.conf 47 | 48 | exec "$@" 49 | -------------------------------------------------------------------------------- /scripts/vpn: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | #Author by @aliasmee 3 | #Time 2018-03-6 01:10 4 | 5 | # Create certificate 6 | cd /data/key_files 7 | ipsec pki --gen --outform pem > ca.pem 8 | ipsec pki --self --in ca.pem --dn "C=cn, O=ilove, CN=Free vpn" --ca --lifetime 3650 --outform pem >ca.cert.pem 9 | ipsec pki --gen --outform pem > server.pem 10 | ipsec pki --gen --outform pem > client.pem 11 | ipsec pki --pub --in server.pem | ipsec pki --issue --lifetime 1200 --cacert ca.cert.pem --cakey ca.pem --dn "C=cn, O=ilove, CN=$HOST_IP" --san="$HOST_IP" --flag serverAuth --flag ikeIntermediate --outform pem > server.cert.pem 12 | ipsec pki --pub --in client.pem | ipsec pki --issue --cacert ca.cert.pem --cakey ca.pem --dn "C=cn, O=ilove, CN=Free vpn client" --outform pem > client.cert.pem 13 | 14 | # Copy certificate to ipsec dir 15 | \cp ca.cert.pem /usr/local/etc/ipsec.d/cacerts/ 16 | \cp server.cert.pem /usr/local/etc/ipsec.d/certs/ 17 | \cp server.pem /usr/local/etc/ipsec.d/private/ 18 | \cp client.cert.pem /usr/local/etc/ipsec.d/certs/ 19 | \cp client.pem /usr/local/etc/ipsec.d/private/ 20 | 21 | # Enable system forward 22 | sysctl -w net.ipv4.ip_forward=1 23 | sysctl -w net.ipv4.ip_no_pmtu_disc=1 24 | 25 | # Load iptables rules 26 | iptables-restore < /etc/sysconfig/iptables 27 | 28 | # Custom connection VPN username password 29 | sed -i "$ a $VPNUSER %any : EAP '$VPNPASS'" /usr/local/etc/ipsec.secrets 30 | 31 | # Reboot ipsec vpn loading cert 32 | supervisorctl restart ipsec 33 | 34 | # View the certificate contents and save file 35 | echo "Below the horizontal line is the content of the certificate. Copy the content to a file in the .cert suffix format. Such as: vpn.cert" 36 | echo "_____________________Good Luck!________________________________________" 37 | cat /data/key_files/ca.cert.pem 38 | 39 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # From alpine:latest image 2 | FROM alpine:latest 3 | 4 | MAINTAINER @aliasmee 5 | 6 | # Define a dynamic variable for Certificate CN 7 | ENV HOST_IP '' 8 | ENV VPNUSER '' 9 | ENV VPNPASS '' 10 | ENV TZ=Asia/Shanghai 11 | 12 | # strongSwan Version 13 | ARG SS_VERSION="https://download.strongswan.org/strongswan-5.6.2.tar.gz" 14 | 15 | # download en 16 | ARG BUILD_DEPS="gettext" 17 | ARG RUNTIME_DEPS="libintl" 18 | 19 | # Install dep packge , Configure,make and install strongSwan 20 | RUN apk --update add build-base curl bash iproute2 iptables-dev openssl openssl-dev supervisor bash && mkdir -p /tmp/strongswan \ 21 | && apk add --update $RUNTIME_DEPS && apk add --virtual build_deps $BUILD_DEPS && cp /usr/bin/envsubst /usr/local/bin/envsubst \ 22 | && curl -Lo /tmp/strongswan.tar.gz $SS_VERSION && tar --strip-components=1 -C /tmp/strongswan -xf /tmp/strongswan.tar.gz \ 23 | && cd /tmp/strongswan \ 24 | && ./configure --enable-eap-identity --enable-eap-md5 --enable-eap-mschapv2 --enable-eap-tls --enable-eap-ttls --enable-eap-peap --enable-eap-tnc --enable-eap-dynamic --enable-eap-radius --enable-xauth-eap --enable-dhcp --enable-openssl --enable-addrblock --enable-unity --enable-certexpire --enable-radattr --enable-swanctl --enable-openssl --disable-gmp && make && make install \ 25 | && rm -rf /tmp/* && apk del build-base curl openssl-dev build_deps && rm -rf /var/cache/apk/* \ 26 | && ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone 27 | 28 | # Change local zonetime(BeiJing) 29 | # RUN \cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime 30 | 31 | # Create cert dir 32 | RUN mkdir -p /data/key_files 33 | 34 | # Copy configure file to ipsec\iptables 35 | COPY ./conf/strongswan.conf /usr/local/etc/strongswan.conf 36 | COPY ./conf/ipsec.secrets /usr/local/etc/ipsec.secrets 37 | COPY ./conf/iptables /etc/sysconfig/iptables 38 | COPY ./conf/supervisord.conf /etc/supervisord.conf 39 | COPY ./conf/eap-radius.conf.template eap-radius.conf.template 40 | COPY ./conf/ipsec.conf.template ipsec.conf.template 41 | 42 | # Make cert script and copy cert to ipsec dir 43 | COPY ./scripts/vpn /usr/bin/vpn 44 | 45 | # Open udp 500\4500 port 46 | EXPOSE 500:500/udp 4500:4500/udp 47 | 48 | # Privilege mode 49 | #CMD ["/usr/bin/supervisord"] 50 | ADD init.sh /init.sh 51 | RUN chmod +x /init.sh 52 | ENTRYPOINT ["/init.sh","/usr/bin/supervisord", "--nodaemon", "--configuration", "/etc/supervisord.conf"] 53 | -------------------------------------------------------------------------------- /conf/eap-radius.conf.template: -------------------------------------------------------------------------------- 1 | eap-radius { 2 | 3 | # Send RADIUS accounting information to RADIUS servers. 4 | accounting = ${ACCOUNTING} 5 | 6 | # Close the IKE_SA if there is a timeout during interim RADIUS accounting 7 | # updates. 8 | # accounting_close_on_timeout = yes 9 | 10 | # Interval in seconds for interim RADIUS accounting updates, if not 11 | # specified by the RADIUS server in the Access-Accept message. 12 | # accounting_interval = 0 13 | 14 | # If enabled, accounting is disabled unless an IKE_SA has at least one 15 | # virtual IP. Only for IKEv2, for IKEv1 a virtual IP is strictly necessary. 16 | # accounting_requires_vip = no 17 | 18 | # Use class attributes in Access-Accept messages as group membership 19 | # information. 20 | # class_group = no 21 | 22 | # Closes all IKE_SAs if communication with the RADIUS server times out. If 23 | # it is not set only the current IKE_SA is closed. 24 | # close_all_on_timeout = no 25 | 26 | # Send EAP-Start instead of EAP-Identity to start RADIUS conversation. 27 | # eap_start = no 28 | 29 | # Use filter_id attribute as group membership information. 30 | # filter_id = no 31 | 32 | # Prefix to EAP-Identity, some AAA servers use a IMSI prefix to select the 33 | # EAP method. 34 | # id_prefix = 35 | 36 | # Whether to load the plugin. Can also be an integer to increase the 37 | # priority of this plugin. 38 | load = yes 39 | 40 | # NAS-Identifier to include in RADIUS messages. 41 | # nas_identifier = strongSwan 42 | 43 | # Port of RADIUS server (authentication). 44 | port = ${RADIUS_PORT} 45 | 46 | # Base to use for calculating exponential back off. 47 | # retransmit_base = 1.4 48 | 49 | # Timeout in seconds before sending first retransmit. 50 | # retransmit_timeout = 2.0 51 | 52 | # Number of times to retransmit a packet before giving up. 53 | # retransmit_tries = 4 54 | 55 | # Shared secret between RADIUS and NAS. If set, make sure to adjust the 56 | # permissions of the config file accordingly. 57 | secret = ${RADIUS_SECRET} 58 | 59 | # IP/Hostname of RADIUS server. 60 | server = ${RADIUS_SERVER} 61 | 62 | # Number of sockets (ports) to use, increase for high load. 63 | # sockets = 1 64 | 65 | dae { 66 | 67 | # Enables support for the Dynamic Authorization Extension (RFC 5176). 68 | # enable = no 69 | 70 | # Address to listen for DAE messages from the RADIUS server. 71 | # listen = 0.0.0.0 72 | 73 | # Port to listen for DAE requests. 74 | # port = 3799 75 | 76 | # Shared secret used to verify/sign DAE messages. If set, make sure to 77 | # adjust the permissions of the config file accordingly. 78 | # secret = 79 | 80 | } 81 | 82 | forward { 83 | 84 | # RADIUS attributes to be forwarded from IKEv2 to RADIUS. 85 | # ike_to_radius = 86 | 87 | # Same as ike_to_radius but from RADIUS to IKEv2. 88 | # radius_to_ike = 89 | 90 | } 91 | 92 | # Section to specify multiple RADIUS servers. 93 | servers { 94 | 95 | } 96 | 97 | # Section to configure multiple XAuth authentication rounds via RADIUS. 98 | xauth { 99 | 100 | } 101 | 102 | } 103 | 104 | -------------------------------------------------------------------------------- /onekey_run_vpnserver.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # File desc: onekey install ikev2 vpn server on docker 3 | # Requirements: ubuntu 16.04+ / Centos7+ 4 | # Time: 2018-05-06 5 | 6 | install_docker(){ 7 | if python -mplatform | grep -qi ubuntu ; then 8 | export os_type=ubuntu 9 | elif python -mplatform | grep -qi centos ; then 10 | export os_type=centos 11 | else 12 | echo -e 'Unknow system platform\n' 13 | fi 14 | 15 | case $os_type in 16 | ubuntu) 17 | echo -e "*************** Install Docker... *******************\n" 18 | sudo apt-get update 19 | sudo apt-get install apt-transport-https ca-certificates ca-certificates software-properties-common dnsutils 20 | curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - 21 | sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" 22 | sudo apt-get update 23 | sudo apt-get install -y docker-ce 24 | sudo systemctl enable docker -q 25 | sudo systemctl start docker 26 | echo -e "\n*************** Install docker on ubuntu. " 27 | ;; 28 | centos) 29 | echo -e "\n*************** Install Docker... *******************" 30 | sudo yum install -y yum-utils device-mapper-persistent-data lvm2 bind-utils 31 | sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo 32 | sudo yum install -y docker-ce-17.12.1.ce-1.el7.centos 33 | sudo systemctl enable docker -q 34 | sudo systemctl start docker 35 | echo -e "\n*************** install docker on centos ***************" 36 | ;; 37 | *) 38 | echo -e "\n*************** please check os platform" 39 | ;; 40 | esac 41 | 42 | } 43 | 44 | # ensure docker is running 45 | running_docker(){ 46 | sudo systemctl start docker 47 | } 48 | 49 | # pull image command 50 | pull_image(){ 51 | echo -e "\n*************** Pull ikev2 vpn image from docker hub... ***************" 52 | sudo docker pull hanyifeng/alpine-ikev2-vpn 53 | } 54 | 55 | # run command 56 | run_docker(){ 57 | sudo docker run --restart=always -itd --privileged -v /lib/modules:/lib/modules \ 58 | -e HOST_IP=$PUBLIC_IP -e VPNUSER=$VPNUSER -e VPNPASS="$VPNPASS" \ 59 | -p 500:500/udp -p 4500:4500/udp --name=ikev2-vpn hanyifeng/alpine-ikev2-vpn 60 | } 61 | 62 | # Run ikev2 server 63 | run_vpnserver(){ 64 | export PUBLIC_IP=`dig +short myip.opendns.com @resolver1.opendns.com` 65 | export VPNUSER=$1 66 | export VPNPASS=$2 67 | CONTAINER_NAME=`sudo docker ps -f name=ikev2-vpn --format '{{.Names}}'` 68 | 69 | echo -e "\n*************** Start vpn server...***************" 70 | 71 | if [ "$CONTAINER_NAME" = 'ikev2-vpn' ]; then 72 | echo -e "\n*************** Delete old vpn server. " 73 | sudo docker rm -f $CONTAINER_NAME 74 | run_docker 75 | else 76 | run_docker 77 | fi 78 | 79 | echo -e "\n*************** Vpn Server is up, just a moment... ***************" 80 | sleep 3 81 | } 82 | 83 | # Generate certificate 84 | generate_cert(){ 85 | echo -e "\n*************** Generate certificate ***************" 86 | sudo docker exec -it ikev2-vpn sh /usr/bin/vpn 87 | echo -e "\n*************** Congratulations. 42. *************** " 88 | echo "Note: Don't forget to set the cloud host's firewall to allow udp port 500 and port 4500 traffic ! ^_^" 89 | } 90 | 91 | 92 | # ensure installed docker engine 93 | command -v docker >/dev/null 2>&1 94 | 95 | if [ $? -eq 0 ] ; then 96 | running_docker 97 | pull_image 98 | run_vpnserver $@ 99 | generate_cert 100 | else 101 | install_docker 102 | running_docker 103 | pull_image 104 | run_vpnserver $@ 105 | generate_cert 106 | fi -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A runing IKEv2 VPN's container on alpine linux system 2 | ## Overview ## 3 | Let the IKEv2 vpn service run in the Docker container, do not need too much configuration, you just take the mirror on the Docker server, then run a container, the container generated certificate copy installed on your client, you can connect vpn The server. Welcome everyone's discussion！:blush: 4 | 5 | ## Features 6 | * based on alpine image and Using supervisor to protect the IPSec process 7 | * StrongSwan provides ikev2 VPN service 8 | * In addition to Android and Linux, but other devices(Winodws 7+,Mac,iOS) by default comes with IKEv2 dial clients 9 | * When the container is run, the certificate file is dynamically generated based on the environment variable (last version) 10 | * Combined with Freeradius achieve Authentication, authorization, and accounting (AAA) (Done -> v0.1) 11 | 12 | ## Prerequisites 13 | * The host can use physical machines, virtual machines, and VPS. 14 | * The host machines and containers must be opened within ip_forward （net.ipv4.ip_forward） 15 | * The host machines Install Docker engine. 16 | * Support eap authentication radius server(EAP-RADIUS) 17 | 18 | ## Usage examples 19 | ### Install using the convenience script `recommended approach` 20 | 21 | 1. As follows 22 | ```bash 23 | # ./onekey_run_vpnserver.sh 'new_vpnuser' 'new_password' 24 | ``` 25 | **$1: vpn user 26 | **$2: vpn password 27 | 28 | 29 | ### Follow steps to install step by step 30 | 31 | 1. Clone git 32 | ```Bash 33 | # git clone https://github.com/aliasmee/alpine-ikev2-vpn.git 34 | ``` 35 | Or use `docker pull` to download images to the local 36 | ```Bash 37 | # docker pull hanyifeng/alpine-ikev2-vpn 38 | ``` 39 | Then run `docker run` command. 40 | 41 | 42 | 2. Using docker build can create an automated build image,Then use the following command to run 43 | ```Bash 44 | # cd alpine-ikev2-vpn/ 45 | # docker build -t ikev2 . 46 | ``` 47 | 48 | * eap-mschapv2 mode 49 | ```bash 50 | # docker run --restart=always -itd --privileged -v /lib/modules:/lib/modules -e HOST_IP='Your's Public network IP' -e VPNUSER=jack -e VPNPASS="jack&opsAdmin" -p 500:500/udp -p 4500:4500/udp --name=ikev2-vpn ikev2 51 | ``` 52 | **HOST_IP :Public network must be your host IP** 53 | **[$VPNUSER] & [$VPNPASS] env Optional,The function is to customize the user name and password to connect to the VPN service.** 54 | **Defalut vpnuser is testUserOne,passwd is testOnePass** 55 | 56 | * eap-radius mode 57 | ```bash 58 | # docker run -itd --privileged -v /lib/modules:/lib/modules -e HOST_IP='Your's Public network IP' -e ACCOUNTING='yes' -e RADIUS_PORT='1812' -e RADIUS_SERVER='Your's radius server IP' -e RADIUS_SECRET='xxxxxxx' -e EAP_TYPE='eap-radius' -p 500:500/udp -p 4500:4500/udp --name=ikev2-vpn ikev2 59 | ``` 60 | **ACCOUNTING: eap-radius mode Required.Value must be 'yes' 61 | **RADIUS_PORT: radius server running port. Required. 62 | **RADIUS_SERVER: radius server ip. Required. 63 | **RADIUS_SECRET: radius nas client psk. Required. 64 | **EAP_TYPE: ikev2 auth mode. Required. 65 | 66 | 3. Use the following command to generate the certificate and view the certificate contents 67 | ```Bash 68 | # docker exec -it ikev2-vpn sh /usr/bin/vpn 69 | net.ipv4.ip_forward = 1 70 | ipsec: stopped 71 | ipsec: started 72 | Below the horizontal line is the content of the certificate. Copy the content to a file in the .cert suffix format. Such as: vpn.cert 73 | ______________________________________________________________ 74 | -----BEGIN CERTIFICATE----- 75 | MIIDKjCCAhKgAwIBAgIIFsVYBZlPYyQwDQYJKoZIhvcNAQELBQAwMzELMAkGA1UE 76 | BhMCY24xDjAMBgNVBAoTBWlsb3ZlMRQwEgYDVQQDEwtqZGNsb3VkIHZwbjAeFw0x 77 | NzA3MjkxNTQzMzVaFw0yNzA3MjcxNTQzMzVaMDMxCzAJBgNVBAYTAmNuMQ4wDAYD 78 | VQQKEwVpbG92ZTEUMBIGA1UEAxMLamRjbG91ZCB2cG4wggEiMA0GCSqGSIb3DQEB 79 | AQUAA4IBDwAwggEKAoIBAQCcCRvhZImsZgIGcaR7oG9mNUJHlP3/UvpClPhWraLe 80 | m19Vi3oumo8QZTrVDbJgih81lL8djhME7b4uWUdSJgkYw8a0UF2Y1St/17HAU161 81 | /C6ETRCsiMFruiSjbfCiHEpegthm6740CWPk1SShRruIxsXqvPZ584M/SGmnxep+ 82 | H+bhT+SshZRsbVlQetf2dDObcEiYqGLTAVpzzhU/X3eBMx2S3Iq41CFAXBQ50vAl 83 | q+uUzBss8GEqY9C9FZJthl+0QQbwEGxrDsGB5+VldNfwNZTv3xOf9lYvtYXDZ9iM 84 | xeCSMsCOgyvnHWT0xAC7EcM9VLC5o38t8l1MHt9meTp9AgMBAAGjQjBAMA8GA1Ud 85 | EwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgEGMB0GA1UdDgQWBBR18mRYIT8/nCJb 86 | AwUYb8wc+R3QsTANBgkqhkiG9w0BAQsFAAOCAQEAFaxgrbFWUkX2StkplufJiSTz 87 | 73kRgOHGoR2FnGcwK6Jh0BTFPVSxn540WFEhEgqbXOrayg2K49NdNB2HheWGZLMr 88 | zHGyEN1oBvYno8muLiWmeP4D3ihC6o99iR+riNaRo43xoYh2ksjetdk/OkbCtSJx 89 | FePMC0WHptGeqyhW3XJfwJ1KZGffXBbsqARXVrG2zstvTHe9vi4JoIvUoGPLNAZ9 90 | T6JXDKrHtWpPofVKuCreJkAn4pu2et9OhOgGYCoQrECVPsuWNtxuFVFYWaok4v2V 91 | VDqjxrbBG+NdgjQm71vCNayb0gwv0qPkU5YLnY8pqloltN6l4fBqkUEqKvqSwA== 92 | -----END CERTIFICATE----- 93 | ``` 94 | 95 | 4. Copy this certificate to the remote client and name it xxx.cert or xxx.cert（Note：Windows need to modify the suffix pem for cer can be installed） 96 | example:
97 | ![](https://github.com/aliasmee/alpine-ikev2-vpn/blob/master/IKEv2_enable_example.png?raw=true) 98 | 99 | 5. Connect vpn it！ 100 | Open the network settings, create a new IKEv2 protocol VPN, enter the default VPN account and password, or use the custom user that starts the container to connect to VPN. 101 | Create new VPN method is not described here ^_^. 102 | 103 | ## Other Tips 104 | 1. If you want to add VPN users, you can run the following command to enter the container and edit the ipsec.secrets file. 105 | ```bash 106 | # docker exec -it ikev2-vpn bash 107 | bash-4.3# vi /usr/local/etc/ipsec.secrets 108 | ``` 109 | **Pattern: testUserOne %any : EAP "testOnePass" ** 110 | 111 | 112 | ``` 113 | bash-4.3# ipsec rereadsecrets 114 | ``` 115 | 116 | ## Plan list 117 | * Dynamically generated based on the environment variable （Completed） 118 | * Support one-click installation (Completed) 119 | * AAA Integrate Radius provides centralized Authentication, Authorization, and Accounting (Completed) 120 | * Clients can connect without having to install a certificate 121 | * Support for adding and deleting user functions 122 | 123 | ## Currently supported client device 124 | Only test for the following client device system，You can test on the other system versions and feedback ！
125 | `Mac`: 10.11.4
126 | `iOS`: 10.2
127 | `Windows`: 10
128 | `Centos`: 6.8
129 | `Android`：(Download strongSwan APK) 130 | 131 | ## Authors 132 | Name: aliasmee
133 | 134 | ## Licensing 135 | This project is licensed under the GNU General Public License - see the [LICENSE.md](https://github.com/aliasmee/IKEv2-radius-vpn/blob/master/LICENSE) file for details 136 | 137 | ## Acknowledgments 138 | https://www.strongswan.org/ 139 | 140 | ## Stargazers over time 141 | 142 | [![Stargazers over time](https://starcharts.herokuapp.com/aliasmee/alpine-ikev2-vpn.svg)](https://starcharts.herokuapp.com/aliasmee/alpine-ikev2-vpn) 143 | -------------------------------------------------------------------------------- /conf/supervisord.conf: -------------------------------------------------------------------------------- 1 | ; Sample supervisor config file. 2 | ; 3 | ; For more information on the config file, please see: 4 | ; http://supervisord.org/configuration.html 5 | ; 6 | ; Notes: 7 | ; - Shell expansion ("~" or "$HOME") is not supported. Environment 8 | ; variables can be expanded using this syntax: "%(ENV_HOME)s". 9 | ; - Quotes around values are not supported, except in the case of 10 | ; the environment= options as shown below. 11 | ; - Comments must have a leading space: "a=b ;comment" not "a=b;comment". 12 | ; - Command will be truncated if it looks like a config file comment, e.g. 13 | ; "command=bash -c 'foo ; bar'" will truncate to "command=bash -c 'foo ". 14 | 15 | [unix_http_server] 16 | file=/var/log/supervisor.sock ; the path to the socket file 17 | ;chmod=0700 ; socket file mode (default 0700) 18 | ;chown=nobody:nogroup ; socket file uid:gid owner 19 | ;username=user ; default is no username (open server) 20 | ;password=123 ; default is no password (open server) 21 | 22 | ;[inet_http_server] ; inet (TCP) server disabled by default 23 | ;port=127.0.0.1:9001 ; ip_address:port specifier, *:port for all iface 24 | ;username=user ; default is no username (open server) 25 | ;password=123 ; default is no password (open server) 26 | 27 | [supervisord] 28 | logfile=/var/log/supervisord.log ; main log file; default $CWD/supervisord.log 29 | logfile_maxbytes=50MB ; max main logfile bytes b4 rotation; default 50MB 30 | logfile_backups=10 ; # of main logfile backups; 0 means none, default 10 31 | loglevel=info ; log level; default info; others: debug,warn,trace 32 | pidfile=/var/log/supervisord.pid ; supervisord pidfile; default supervisord.pid 33 | nodaemon=false ; start in foreground if true; default false 34 | minfds=1024 ; min. avail startup file descriptors; default 1024 35 | minprocs=200 ; min. avail process descriptors;default 200 36 | ;umask=022 ; process file creation umask; default 022 37 | ;user=chrism ; default is current user, required if root 38 | ;identifier=supervisor ; supervisord identifier, default is 'supervisor' 39 | ;directory=/tmp ; default is not to cd during start 40 | ;nocleanup=true ; don't clean up tempfiles at start; default false 41 | childlogdir=/var/log/ ; 'AUTO' child log dir, default $TEMP 42 | ;environment=KEY="value" ; key value pairs to add to environment 43 | ;strip_ansi=false ; strip ansi escape codes in logs; def. false 44 | 45 | ; The rpcinterface:supervisor section must remain in the config file for 46 | ; RPC (supervisorctl/web interface) to work. Additional interfaces may be 47 | ; added by defining them in separate [rpcinterface:x] sections. 48 | 49 | [rpcinterface:supervisor] 50 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 51 | 52 | ; The supervisorctl section configures how supervisorctl will connect to 53 | ; supervisord. configure it match the settings in either the unix_http_server 54 | ; or inet_http_server section. 55 | 56 | [supervisorctl] 57 | serverurl=unix:///var/log/supervisor.sock ; use a unix:// URL for a unix socket 58 | ;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket 59 | ;username=chris ; should be same as in [*_http_server] if set 60 | ;password=123 ; should be same as in [*_http_server] if set 61 | ;prompt=mysupervisor ; cmd line prompt (default "supervisor") 62 | ;history_file=~/.sc_history ; use readline history if available 63 | 64 | ; The sample program section below shows all possible program subsection values. 65 | ; Create one or more 'real' program: sections to be able to control them under 66 | ; supervisor. 67 | 68 | ;[program:theprogramname] 69 | ;command=/bin/cat ; the program (relative uses PATH, can take args) 70 | ;process_name=%(program_name)s ; process_name expr (default %(program_name)s) 71 | ;numprocs=1 ; number of processes copies to start (def 1) 72 | ;directory=/tmp ; directory to cwd to before exec (def no cwd) 73 | ;umask=022 ; umask for process (default None) 74 | ;priority=999 ; the relative start priority (default 999) 75 | ;autostart=true ; start at supervisord start (default: true) 76 | ;startsecs=1 ; # of secs prog must stay up to be running (def. 1) 77 | ;startretries=3 ; max # of serial start failures when starting (default 3) 78 | ;autorestart=unexpected ; when to restart if exited after running (def: unexpected) 79 | ;exitcodes=0,2 ; 'expected' exit codes used with autorestart (default 0,2) 80 | ;stopsignal=QUIT ; signal used to kill process (default TERM) 81 | ;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10) 82 | ;stopasgroup=false ; send stop signal to the UNIX process group (default false) 83 | ;killasgroup=false ; SIGKILL the UNIX process group (def false) 84 | ;user=chrism ; setuid to this UNIX account to run the program 85 | ;redirect_stderr=true ; redirect proc stderr to stdout (default false) 86 | 87 | ; The rpcinterface:supervisor section must remain in the config file for 88 | ; RPC (supervisorctl/web interface) to work. Additional interfaces may be 89 | ; added by defining them in separate [rpcinterface:x] sections. 90 | 91 | [rpcinterface:supervisor] 92 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 93 | 94 | ; The supervisorctl section configures how supervisorctl will connect to 95 | ; supervisord. configure it match the settings in either the unix_http_server 96 | ; or inet_http_server section. 97 | 98 | [supervisorctl] 99 | serverurl=unix:///var/log/supervisor.sock ; use a unix:// URL for a unix socket 100 | ;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket 101 | ;username=chris ; should be same as in [*_http_server] if set 102 | ;password=123 ; should be same as in [*_http_server] if set 103 | ;prompt=mysupervisor ; cmd line prompt (default "supervisor") 104 | ;history_file=~/.sc_history ; use readline history if available 105 | 106 | ; The sample program section below shows all possible program subsection values. 107 | ; Create one or more 'real' program: sections to be able to control them under 108 | ; supervisor. 109 | 110 | ;[program:theprogramname] 111 | ;command=/bin/cat ; the program (relative uses PATH, can take args) 112 | ;process_name=%(program_name)s ; process_name expr (default %(program_name)s) 113 | ;numprocs=1 ; number of processes copies to start (def 1) 114 | ;directory=/tmp ; directory to cwd to before exec (def no cwd) 115 | ;umask=022 ; umask for process (default None) 116 | ;priority=999 ; the relative start priority (default 999) 117 | ;autostart=true ; start at supervisord start (default: true) 118 | ;startsecs=1 ; # of secs prog must stay up to be running (def. 1) 119 | ;startretries=3 ; max # of serial start failures when starting (default 3) 120 | ;autorestart=unexpected ; when to restart if exited after running (def: unexpected) 121 | ;exitcodes=0,2 ; 'expected' exit codes used with autorestart (default 0,2) 122 | ;stopsignal=QUIT ; signal used to kill process (default TERM) 123 | ;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10) 124 | ;stopasgroup=false ; send stop signal to the UNIX process group (default false) 125 | ;killasgroup=false ; SIGKILL the UNIX process group (def false) 126 | ;user=chrism ; setuid to this UNIX account to run the program 127 | ;redirect_stderr=true ; redirect proc stderr to stdout (default false) 128 | ;stdout_logfile=/a/path ; stdout log path, NONE for none; default AUTO 129 | ;stdout_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB) 130 | ;stdout_logfile_backups=10 ; # of stdout logfile backups (0 means none, default 10) 131 | ;stdout_events_enabled=false ; emit events on stdout writes (default false) 132 | ;stderr_logfile=/a/path ; stderr log path, NONE for none; default AUTO 133 | ;stderr_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB) 134 | ;stderr_logfile_backups=10 ; # of stderr logfile backups (0 means none, default 10) 135 | ;stderr_events_enabled=false ; emit events on stderr writes (default false) 136 | ;environment=A="1",B="2" ; process environment additions 137 | ;serverurl=AUTO ; override serverurl computation (childutils) 138 | 139 | ; The sample group section below shows all possible group values. Create one 140 | ; or more 'real' group: sections to create "heterogeneous" process groups. 141 | 142 | ;[group:thegroupname] 143 | ;programs=progname1,progname2 ; each refers to 'x' in [program:x] definitions 144 | ;priority=999 ; the relative start priority (default 999) 145 | 146 | ; The [include] section can just contain the "files" setting. This 147 | ; setting can list multiple files (separated by whitespace or 148 | ; newlines). It can also contain wildcards. The filenames are 149 | ; interpreted as relative to this file. Included files *cannot* 150 | ; include files themselves. 151 | 152 | ;[include] 153 | ;files = relative/directory/*.ini 154 | 155 | 156 | [program:ipsec] 157 | command=/usr/local/sbin/ipsec start --nofork 158 | stdout_logfile=/var/log/ikev2.log 159 | stdout_logfile_maxbytes=20MB 160 | autostart=true 161 | autorestart=true 162 | startsecs=5 163 | priority=3 164 | stopasgroup=true 165 | killasgroup=true 166 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------