openvpn-storm is a storm plugin for managing the openvpn service.
It provides the REST API to configure the openvpn server and start the server using stormflash framework. Also the openvpn process is monitored by the stormflash.
| Verb | URI | Description |
|---|---|---|
| POST | /openvpn/server | Create openvpn server configuration |
| POST | /openvpn/server/:server/users | Add user to openvpn server configuration |
| GET | /openvpn/server | Describe openvpn server info |
| GET | /openvpn/server/:id | Describe server server-id openvpn info |
| DELETE | /openvpn/server/:id/users/:user | Delete user from server with server-id |
| DELETE | /openvpn/server/:server | Delete server-id info from server |
POST openvpn API
Verb URI Description
POST /openvpn/server Create openvpn server configuration and starts the openvpn server
Example Request and Response
{
"port": 7000,
"dev": "tun1",
"proto": "udp",
"ca": "/var/stormflash/meta/ca-bundle.pem",
"dh": "/etc/dh1024.pem",
"cert": "/var/stormflash/meta/openvpn.cert",
"key": "/var/stormflash/meta/openvpn.key",
"server": "172.17.0.0 255.255.255.0",
"multihome": true,
"management": "127.0.0.1 2020",
"cipher": "AES-256-CBC",
"auth": "SHA1",
"topology": "subnet",
"route": null,
"push": [
"comp-lzo no"
],
"status": "/var/log/server-status.log",
"keepalive": "5 60",
"sndbuf": 262144,
"rcvbuf": 262144,
"txqueuelen": 500,
"verb": 3,
"mlock": true,
"script-security": "3 system",
"tls-cipher": "DHE-RSA-AES256-SHA",
"route-gateway": "172.17.0.1",
"client-config-dir": "/var/stormflash/meta/ccd",
"ccd-exclusive": true,
"max-clients": 254,
"persist-key": true,
"persist-tun": true,
"comp-lzo": "no",
"replay-window": "512 15",
"client-to-client": true
}
{
"id": "b90736af-b58f-4929-8e9a-de4bf0fd7aa5",
"running": true
}
POST openvpn user API
Verb URI Description
POST /openvpn/server/:server/users Add openvpn user.
Example Request and Response
[
{
"id": "439ecacc-979f-47f9-9ea0-1cc3bc7005ed",
"email": "[email protected]",
"cname": "[email protected]",
"push": [
"dhcp-option DNS 8.8.8.8",
"ip-win32 dynamic",
"route-delay 5",
"redirect-gateway def1"
]
}
]
{
"439ecacc-979f-47f9-9ea0-1cc3bc7005ed": {
"id": "439ecacc-979f-47f9-9ea0-1cc3bc7005ed",
"email": "[email protected]",
"cname": "[email protected]",
"push": [
"dhcp-option DNS 8.8.8.8",
"ip-win32 dynamic",
"route-delay 5",
"redirect-gateway def1"
],
"ccdpath": "/var/stormflash/meta/ccd",
"saved": true
}
}
GET openvpn server API
Verb URI Description
GET /openvpn/server Show openvpn server configuration.
Example Request and Response
[
{
"id": "b90736af-b58f-4929-8e9a-de4bf0fd7aa5",
"data": {
"port": 7000,
"dev": "tun1",
"proto": "udp",
"ca": "/var/stormflash/meta/ca-bundle.pem",
"dh": "/etc/dh1024.pem",
"cert": "/var/stormflash/meta/openvpn.cert",
"key": "/var/stormflash/meta/openvpn.key",
"server": "172.17.0.0 255.255.255.0",
"multihome": true,
"management": "127.0.0.1 2020",
"cipher": "AES-256-CBC",
"auth": "SHA1",
"topology": "subnet",
"route": null,
"push": [
"comp-lzo no"
],
"status": "/var/log/server-status.log",
"keepalive": "5 60",
"sndbuf": 262144,
"rcvbuf": 262144,
"txqueuelen": 500,
"verb": 3,
"mlock": true,
"script-security": "3 system",
"tls-cipher": "DHE-RSA-AES256-SHA",
"route-gateway": "172.17.0.1",
"client-config-dir": "/var/stormflash/meta/ccd",
"ccd-exclusive": true,
"max-clients": 254,
"persist-key": true,
"persist-tun": true,
"comp-lzo": "no",
"replay-window": "512 15",
"client-to-client": true
},
"saved": true,
"isRunning": true,
"_events": {
"running": [
null,
null
]
},
"configPath": "/var/stormflash/plugins/openvpn",
"logPath": "/var/log/openvpn",
"out": 22,
"err": 24,
"configs": {
"service": {
"filename": "/var/stormflash/plugins/openvpn/b90736af-b58f-4929-8e9a-de4bf0fd7aa5.conf"
}
},
"invocation": {
"name": "openvpn",
"path": "/usr/sbin",
"monitor": true,
"args": [
"--config",
"/var/stormflash/plugins/openvpn/b90736af-b58f-4929-8e9a-de4bf0fd7aa5.conf"
],
"options": {
"detached": true,
"stdio": [
"ignore",
22,
24
]
}
},
"isReady": true,
"instance": 12862
}
]
GET openvpn server API
Verb URI Description
GET /openvpn/server/:id Show openvpn server configuration by ID.
Example Request and Response
{
"id": "b90736af-b58f-4929-8e9a-de4bf0fd7aa5",
"data": {
"port": 7000,
"dev": "tun1",
"proto": "udp",
"ca": "/var/stormflash/meta/ca-bundle.pem",
"dh": "/etc/dh1024.pem",
"cert": "/var/stormflash/meta/openvpn.cert",
"key": "/var/stormflash/meta/openvpn.key",
"server": "172.17.0.0 255.255.255.0",
"multihome": true,
"management": "127.0.0.1 2020",
"cipher": "AES-256-CBC",
"auth": "SHA1",
"topology": "subnet",
"route": null,
"push": [
"comp-lzo no"
],
"status": "/var/log/server-status.log",
"keepalive": "5 60",
"sndbuf": 262144,
"rcvbuf": 262144,
"txqueuelen": 500,
"verb": 3,
"mlock": true,
"script-security": "3 system",
"tls-cipher": "DHE-RSA-AES256-SHA",
"route-gateway": "172.17.0.1",
"client-config-dir": "/var/stormflash/meta/ccd",
"ccd-exclusive": true,
"max-clients": 254,
"persist-key": true,
"persist-tun": true,
"comp-lzo": "no",
"replay-window": "512 15",
"client-to-client": true
},
"saved": true,
"isRunning": true,
"_events": {
"running": [
null,
null
]
},
"configPath": "/var/stormflash/plugins/openvpn",
"logPath": "/var/log/openvpn",
"out": 22,
"err": 24,
"configs": {
"service": {
"filename": "/var/stormflash/plugins/openvpn/b90736af-b58f-4929-8e9a-de4bf0fd7aa5.conf"
}
},
"invocation": {
"name": "openvpn",
"path": "/usr/sbin",
"monitor": true,
"args": [
"--config",
"/var/stormflash/plugins/openvpn/b90736af-b58f-4929-8e9a-de4bf0fd7aa5.conf"
],
"options": {
"detached": true,
"stdio": [
"ignore",
22,
24
]
}
},
"isReady": true,
"instance": 12862
}
DELETE openvpn user API
Verb URI Description
DELETE /openvpn/server/:id/users/:user Delete openvpn user from client-config-directory
Example Request and Response
Status Code: 204 No Content
DELETE openvpn API
Verb URI Description
DELETE openvpn/server/:server Delete openvpn configuration by ID.
Example Request and Response
Status Code: 204 No Content
Connection: keep-alive
LICENSE
MIT
COPYRIGHT AND PERMISSION NOTICE
Copyright (c) 2014-2015, Clearpath Networks, [email protected].
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.