Add client setup docs for IPsec/XAUTH

README-zh.md

@@ -94,7 +94,7 @@ sudo sh vpnsetup_centos.sh
 
 配置你的计算机或其它设备使用 VPN 。请参见： <a href="docs/clients-zh.md" target="_blank">配置 IPsec/L2TP VPN 客户端</a>。
 
-**新特性：** 在 `IPsec/L2TP` 的基础上，现在新增对 `IPsec/XAUTH` 的支持！它能够更快和更高效地传输数据。该模式在 Android 上被称为 `Xauth PSK`，在 iOS/OSX 上被称为 `(Cisco) IPSec`。Windows 用户可以使用免费的 <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft 客户端</a>。
+**新特性：** 在 `IPsec/L2TP` 的基础上，现在新增对 `IPsec/XAUTH` 的支持。请参见： <a href="docs/clients-xauth-zh.md" target="_blank">配置 IPsec/XAUTH VPN 客户端</a>。
 
 开始使用自己的专属 VPN ! :sparkles::tada::rocket::sparkles:
 
@@ -104,7 +104,7 @@ sudo sh vpnsetup_centos.sh
 
 **Android 6 (Marshmallow) 用户**: 请编辑 `/etc/ipsec.conf` 并在 `ike=` 和 `phase2alg=` 两行结尾添加 `,aes256-sha2_256` 。另外<a href="https://libreswan.org/wiki/FAQ#Android_6.0_connection_comes_up_but_no_packet_flow" target="_blank">增加一行</a> `sha2-truncbug=yes` 。每行开头必须空两格。保存修改并运行 `service ipsec restart` 。
 
-如果要为 `IPsec/L2TP` 创建具有不同凭据的多个 VPN 用户，只需要<a href="docs/enable-multiple-users.txt" target="_blank">修改这几行的脚本</a>。
+如果要创建具有不同凭据的多个 VPN 用户，只需要<a href="docs/enable-multiple-users.txt" target="_blank">修改这几行的脚本</a>。
 
 在 VPN 已连接时，客户端配置为使用 <a href="https://developers.google.com/speed/public-dns/" target="_blank">Google Public DNS</a>。此设置可通过编辑文件 `options.xl2tpd` 和 `ipsec.conf` 来更改。
 

README.md

@@ -94,7 +94,7 @@ If unable to download via `wget`, you may alternatively open <a href="vpnsetup.s
 
 Get your computer or device to use the VPN. Please see: <a href="docs/clients.md" target="_blank">Configure IPsec/L2TP VPN Clients</a>.
 
-**NEW:** `IPsec/XAUTH` is now supported in addition to `IPsec/L2TP`! This new mode is faster with less overhead. On Android, this mode is called `Xauth PSK`. On iOS/OSX it is called `(Cisco) IPSec`. Windows users can use the free <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft client</a>.
+**NEW:** `IPsec/XAUTH` is now supported in addition to `IPsec/L2TP`. See: <a href="docs/clients-xauth.md" target="_blank">Configure IPsec/XAUTH VPN Clients</a>.
 
 Enjoy your very own VPN! :sparkles::tada::rocket::sparkles:
 
@@ -104,7 +104,7 @@ For **Windows users**, a <a href="https://documentation.meraki.com/MX-Z/Client_V
 
 **Android 6 (Marshmallow) users**: Edit `/etc/ipsec.conf` and append `,aes256-sha2_256` to both `ike=` and `phase2alg=`. Then <a href="https://libreswan.org/wiki/FAQ#Android_6.0_connection_comes_up_but_no_packet_flow" target="_blank">add a new line</a> `sha2-truncbug=yes`. Indent lines with two spaces. Finally, run `service ipsec restart`.
 
-To create multiple VPN users with different credentials for `IPsec/L2TP`, just <a href="docs/enable-multiple-users.txt" target="_blank">edit a few lines</a> in the scripts.
+To create multiple VPN users with different credentials, just <a href="docs/enable-multiple-users.txt" target="_blank">edit a few lines</a> in the scripts.
 
 Clients are set to use <a href="https://developers.google.com/speed/public-dns/" target="_blank">Google Public DNS</a> when the VPN is active. To change, edit `options.xl2tpd` and `ipsec.conf`.
 

docs/clients-xauth-zh.md

@@ -0,0 +1,103 @@
+## 配置 IPsec/XAUTH VPN 客户端
+
+*Read this in other languages: [English](clients-xauth.md), [简体中文](clients-xauth-zh.md).*
+
+*如需使用 IPsec/L2TP 模式连接，请参见： [配置 IPsec/L2TP VPN 客户端](clients-zh.md)*
+
+在成功<a href="https://github.com/hwdsl2/setup-ipsec-vpn" target="_blank">搭建自己的VPN服务器</a>之后，你可以按照下面的步骤来配置你的设备。IPsec/XAUTH 在 Android, iOS 和 OS X 上均受支持，无需安装额外的软件。Windows 用户可以使用免费的 <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft 客户端</a>。如果无法连接,请首先检查是否输入了正确的用户名和密码。
+
+`IPsec/XAUTH` 模式也称为 `Cisco IPsec`。和 `IPsec/L2TP` 相比较，它通常能够更快速和更高效地传输数据。
+
+---
+* 平台名称
+  * [Windows](#windows)
+  * [OS X](#os-x)
+  * [Android](#android)
+  * [iOS](#ios)
+
+### Windows ###
+
+注: 你也可以使用 [IPsec/L2TP 模式](clients-zh.md) 连接，无需安装额外的软件。
+
+1. 下载并安装免费的 <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft VPN 客户端</a>。
+1. 单击开始菜单 -> 所有程序 -> ShrewSoft VPN Client -> VPN Access Manager
+1. 单击工具栏中的 **Add (+)** 按钮。
+1. 在 **Host Name or IP Address** 字段中输入`你的 VPN 服务器 IP`。
+1. 单击 **Authentication** 选项卡，从 **Authentication Method** 下拉菜单中选择 **Mutual PSK + XAuth**。
+1. 单击 **Credentials** 子选项卡，并在 **Pre Shared Key** 字段中输入`你的 IPsec PSK`。
+1. 单击 **Phase 1** 选项卡，从 **Exchange Type** 下拉菜单中选择 **main**。
+1. 单击 **Save** 保存 VPN 连接的详细信息。
+1. 选择新添加的 VPN 连接。单击工具栏中的 **Connect** 按钮。
+1. 在 **Username** 字段中输入`你的 VPN 用户名`。
+1. 在 **Password** 字段中输入`你的 VPN 密码`。
+1. 单击 **Connect**。
+
+注： 在首次连接之前需要<a href="https://documentation.meraki.com/MX-Z/Client_VPN/Troubleshooting_Client_VPN#Windows_Error_809" target="_blank">修改一次注册表</a>，以解决 VPN 服务器和客户端与 NAT （比如家用路由器）的兼容问题。请按照链接文章中的说明进行操作，并在完成后重新启动计算机。
+
+VPN 连接成功后，会在 VPN Connect 状态窗口中显示 **tunnel enabled** 字样。最后你可以到<a href="https://www.whatismyip.com" target="_blank">这里</a>检测你的 IP 地址，应该显示为`你的 VPN 服务器 IP`。
+
+### OS X ###
+1. 打开系统偏好设置并转到网络部分。
+1. 在窗口左下角单击 **+** 按钮。
+1. 从 **接口** 下拉菜单选择 **VPN**。
+1. 从 **VPN类型** 下拉菜单选择 **Cisco IPSec**。
+1. 在 **服务名称** 字段中输入任意内容。
+1. 单击 **创建**。
+1. 在 **服务器地址** 字段中输入`你的 VPN 服务器 IP`。
+1. 在 **帐户名称** 字段中输入`你的 VPN 用户名`。
+1. 在 **密码** 字段中输入`你的 VPN 密码`。
+1. 单击 **鉴定设置** 按钮。
+1. 在 **机器鉴定** 部分，选择 **共享的密钥** 单选按钮，然后输入`你的 IPsec PSK`。
+1. 保持 **群组名称** 字段空白。
+1. 单击 **好**。
+1. 选中 **在菜单栏中显示 VPN 状态** 复选框。
+1. 单击 **应用** 保存VPN连接信息。
+
+要连接到 VPN，你可以使用菜单栏中的 VPN 图标，或者在系统偏好设置的网络部分选择 VPN，并单击 **连接**。最后你可以到<a href="https://www.whatismyip.com" target="_blank">这里</a>检测你的 IP 地址，应该显示为`你的 VPN 服务器 IP`。
+
+### Android ###
+1. 启动 **设置** 应用程序。
+1. 在 **无线和网络** 部分单击 **更多...**。
+1. 单击 **VPN**。
+1. 单击 **添加VPN配置文件** 或窗口右上角的 **+**。
+1. 在 **名称** 字段中输入任意内容。
+1. 在 **类型** 下拉菜单选择 **IPSec Xauth PSK**。
+1. 在 **服务器地址** 字段中输入`你的 VPN 服务器 IP`。
+1. 保持 **IPSec 标识符** 字段空白。
+1. 在 **IPSec 预共享密钥** 字段中输入`你的 IPsec PSK`。
+1. 单击 **保存**。
+1. 单击新的VPN连接。
+1. 在 **用户名** 字段中输入`你的 VPN 用户名`。
+1. 在 **密码** 字段中输入`你的 VPN 密码`。
+1. 选中 **保存帐户信息** 复选框。
+1. 单击 **连接**。
+
+VPN 连接成功后，会在通知栏显示图标。最后你可以到<a href="https://www.whatismyip.com" target="_blank">这里</a>检测你的 IP 地址，应该显示为`你的 VPN 服务器 IP`。
+
+### iOS ###
+1. 进入设置 -> 通用 -> VPN。
+1. 单击 **添加VPN配置...**。
+1. 单击 **类型** 。选择 **IPSec** 并返回。
+1. 在 **描述** 字段中输入任意内容。
+1. 在 **服务器** 字段中输入`你的 VPN 服务器 IP`。
+1. 在 **帐户** 字段中输入`你的 VPN 用户名`。
+1. 在 **密码** 字段中输入`你的 VPN 密码`。
+1. 保持 **群组名称** 字段空白。
+1. 在 **密钥** 字段中输入`你的 IPsec PSK`。
+1. 单击右上角的 **存储**。
+1. 启用 **VPN** 连接。
+
+VPN 连接成功后，会在通知栏显示图标。最后你可以到<a href="https://www.whatismyip.com" target="_blank">这里</a>检测你的 IP 地址，应该显示为`你的 VPN 服务器 IP`。
+
+## 致谢
+
+本文档是在 <a href="https://github.com/jlund/streisand" target="_blank">Streisand</a> 项目文档基础上翻译和修改。该项目由 Joshua Lund 和其他开发者维护。
+
+## 授权协议
+
+版权所有 (C) 2016 Lin Song   
+基于 <a href="https://github.com/jlund/streisand/blob/master/playbooks/roles/l2tp-ipsec/templates/instructions.md.j2" target="_blank">Joshua Lund 的工作</a> (版权所有 2014-2016)
+
+本程序为自由软件，在自由软件联盟发布的<a href="https://www.gnu.org/licenses/gpl.html" target="_blank"> GNU 通用公共许可协议</a>的约束下，你可以对其进行再发布及修改。协议版本为第三版或（随你）更新的版本。
+
+我们希望发布的这款程序有用，但不保证，甚至不保证它有经济价值和适合特定用途。详情参见GNU通用公共许可协议。

docs/clients-xauth.md

@@ -0,0 +1,103 @@
+## Configure IPsec/XAUTH VPN Clients
+
+*Read this in other languages: [English](clients-xauth.md), [简体中文](clients-xauth-zh.md).*
+
+*To connect using IPsec/L2TP mode, see: [Configure IPsec/L2TP VPN Clients](clients.md)*
+
+After <a href="https://github.com/hwdsl2/setup-ipsec-vpn" target="_blank">setting up your own VPN server</a>, follow these steps to configure your devices. IPsec/XAUTH is natively supported by Android, iOS and OS X. There is no additional software to install. Windows users can use the free <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft client</a>. In case you are unable to connect, first check to make sure the VPN credentials were entered correctly.
+
+`IPsec/XAUTH` mode is also called `Cisco IPsec`. Compared to `IPsec/L2TP`, it is generally faster with less overhead.
+
+---
+* Platforms
+  * [Windows](#windows)
+  * [OS X](#os-x)
+  * [Android](#android)
+  * [iOS](#ios)
+
+### Windows ###
+
+Note: You may also connect using [IPsec/L2TP mode](clients.md). No additional software is required.
+
+1. Download and install the free <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft VPN client</a>.
+1. Click Start Menu -> All Programs -> ShrewSoft VPN Client -> VPN Access Manager
+1. Click the **Add (+)** button on toolbar.
+1. Enter `Your VPN Server IP` in the **Host Name or IP Address** field.
+1. Click the **Authentication** tab. Select **Mutual PSK + XAuth** from the **Authentication Method** drop-down menu.
+1. Click the **Credentials** tab below. Enter `Your IPsec PSK` in the **Pre Shared Key** field.
+1. Click the **Phase 1** tab. Select **main** from the **Exchange Type** drop-down menu.
+1. Click **Save** to save the VPN connection details.
+1. Select the new VPN connection. Click the **Connect** button on toolbar.
+1. Enter `Your VPN Username` in the **Username** field.
+1. Enter `Your VPN Password` in the **Password** field.
+1. Click **Connect**.
+
+Note: A <a href="https://documentation.meraki.com/MX-Z/Client_VPN/Troubleshooting_Client_VPN#Windows_Error_809" target="_blank">one-time registry change</a> is required if the VPN server and/or client is behind NAT (e.g. home router). Please follow instructions in the linked article, and reboot your computer when done.
+
+Once connected, you will see **tunnel enabled** in the VPN Connect status window. You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
+
+### OS X ###
+1. Open System Preferences and go to the Network section.
+1. Click the **+** button in the lower-left corner of the window.
+1. Select **VPN** from the **Interface** drop-down menu.
+1. Select **Cisco IPSec** from the **VPN Type** drop-down menu.
+1. Enter anything you like for the **Service Name**.
+1. Click **Create**.
+1. Enter `Your VPN Server IP` for the **Server Address**.
+1. Enter `Your VPN Username` for the **Account Name**.
+1. Enter `Your VPN Password` for the **Password**.
+1. Click the **Authentication Settings** button.
+1. In the **Machine Authentication** section, select the **Shared Secret** radio button and enter `Your IPsec PSK` as its value.
+1. Leave the **Group Name** field blank.
+1. Click **OK**.
+1. Check the **Show VPN status in menu bar** checkbox.
+1. Click **Apply** to save the VPN connection information.
+
+You can connect to the VPN using the VPN icon in the menu bar, or by selecting the VPN in the Network section of System Preferences and choosing **Connect**. You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
+
+### Android ###
+1. Launch the **Settings** application.
+1. Tap **More...** in the **Wireless & Networks** section.
+1. Tap **VPN**.
+1. Tap **Add VPN Profile** or the **+** icon at top-right of screen.
+1. Enter anything you like in the **Name** field.
+1. Select **IPSec Xauth PSK** in the **Type** drop-down menu.
+1. Enter `Your VPN Server IP` in the **Server address** field.
+1. Leave the **IPSec identifier** field blank.
+1. Enter `Your IPsec PSK` in the **IPSec pre-shared key** field.
+1. Tap **Save**.
+1. Tap the new VPN connection.
+1. Enter `Your VPN Username` in the **Username** field.
+1. Enter `Your VPN Password` in the **Password** field.
+1. Check the **Save account information** checkbox.
+1. Tap **Connect**.
+
+Once connected, you will see a VPN icon in the notification bar. You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
+
+### iOS ###
+1. Go to Settings -> General -> VPN.
+1. Tap **Add VPN Configuration...**.
+1. Tap **Type**. Select **IPSec** and go back.
+1. Tap **Description** and enter anything you like.
+1. Tap **Server** and enter `Your VPN Server IP`.
+1. Tap **Account** and enter `Your VPN Username`.
+1. Tap **Password** and enter `Your VPN Password`.
+1. Leave the **Group Name** field blank.
+1. Tap **Secret** and enter `Your IPsec PSK`.
+1. Tap **Done**.
+1. Slide the **VPN** switch ON.
+
+Once connected, you will see a VPN icon in the status bar. You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
+
+## Acknowledgement
+
+This document was adapted from the <a href="https://github.com/jlund/streisand" target="_blank">Streisand</a> project by Joshua Lund and contributors.
+
+## License
+
+Copyright (C) 2016 Lin Song   
+Based on <a href="https://github.com/jlund/streisand/blob/master/playbooks/roles/l2tp-ipsec/templates/instructions.md.j2" target="_blank">the work of Joshua Lund</a> (Copyright 2014-2016)
+
+This program is free software: you can redistribute it and/or modify it under the terms of the <a href="https://www.gnu.org/licenses/gpl.html" target="_blank">GNU General Public License</a> as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

docs/clients-zh.md

@@ -2,7 +2,7 @@
 
 *Read this in other languages: [English](clients.md), [简体中文](clients-zh.md).*
 
-注： 本文档是在 <a href="https://github.com/jlund/streisand" target="_blank">Streisand</a> 项目文档基础上翻译和修改。该项目由 Joshua Lund 和其他开发者维护。 授权协议： [GPLv3](#授权协议)。
+*如需使用 IPsec/XAUTH 模式连接，请参见： [配置 IPsec/XAUTH VPN 客户端](clients-xauth-zh.md)*
 
 在成功<a href="https://github.com/hwdsl2/setup-ipsec-vpn" target="_blank">搭建自己的VPN服务器</a>之后，你可以按照下面的步骤来配置你的设备。IPsec/L2TP 在 Android, iOS, OS X 和 Windows 上均受支持，无需安装额外的软件。设置过程通常只需要几分钟。如果无法连接,请首先检查是否输入了正确的用户名和密码。
 
@@ -113,6 +113,10 @@ VPN 连接成功后，会在通知栏显示图标。最后你可以到<a href="h
 
 VPN 连接成功后，网络状态图标上会出现 VPN 指示。最后你可以到<a href="https://www.whatismyip.com" target="_blank">这里</a>检测你的 IP 地址，应该显示为`你的 VPN 服务器 IP`。
 
+## 致谢
+
+本文档是在 <a href="https://github.com/jlund/streisand" target="_blank">Streisand</a> 项目文档基础上翻译和修改。该项目由 Joshua Lund 和其他开发者维护。
+
 ## 授权协议
 
 版权所有 (C) 2016 Lin Song   

docs/clients.md

@@ -2,7 +2,7 @@
 
 *Read this in other languages: [English](clients.md), [简体中文](clients-zh.md).*
 
-Note: This document was adapted from the <a href="https://github.com/jlund/streisand" target="_blank">Streisand</a> project by Joshua Lund and contributors. License: [GPLv3](#license).
+*To connect using IPsec/XAUTH mode, see: [Configure IPsec/XAUTH VPN Clients](clients-xauth.md)*
 
 After <a href="https://github.com/hwdsl2/setup-ipsec-vpn" target="_blank">setting up your own VPN server</a>, follow these steps to configure your devices. IPsec/L2TP is natively supported by Android, iOS, OS X, and Windows. There is no additional software to install. Setup should only take a few minutes. In case you are unable to connect, first check to make sure the VPN credentials were entered correctly.
 
@@ -113,6 +113,10 @@ Once connected, you will see a VPN icon in the status bar. You can verify that y
 
 Once connected, you will see a VPN icon overlay on the network status icon. You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
 
+## Acknowledgement
+
+This document was adapted from the <a href="https://github.com/jlund/streisand" target="_blank">Streisand</a> project by Joshua Lund and contributors.
+
 ## License
 
 Copyright (C) 2016 Lin Song   

docs/enable-multiple-users.txt

@@ -1,4 +1,4 @@
-To enable multiple VPN users with different credentials,
+To create multiple VPN users with different credentials for IPsec/L2TP,
  find and replace these lines in the script:
 
 cat > /etc/ppp/chap-secrets <<EOF
@@ -22,3 +22,5 @@ EOF
    You can add more users, use one line for each user.
 3. The characters \ and " within your username/password (if present)
    MUST be escaped as \\ and \", respectively.
+4. To create multiple VPN users for IPsec/XAUTH, add more lines to file
+   "/etc/ipsec.d/passwd". Refer to the VPN script for correct format.