rk295.openvpnas
Ansible role: openvpn as configure
This role enables idempotent configuration of the OpenVPN Access Server via the vendor provided sacli utility.
Currently it supports all the keys available via the ConfigPut option to sacli, but none of the other configurable items. Any PR's adding extra functionality will be welcomed.
Details
To ensure we don't run all the tasks every time Ansible runs, we deploy a simple idempotent wrapper files/config-set to the host on the first run (this uses jq, which the role will install). This script checks the current value for a given key only setting a new value if it differs from the current configuration.
The full list of options to ConfigPut is held in a list of maps in vars/main.yml, this enables Ansible friendly variable names to be used, these being looked up in that map at run time. If you find an option I've missed, or one that lacks documentation in the Variables section below, please feel free to submit a PR.
Requirements
Currently it is intended to be run against the OpenVPN AS Appliance as provided by OpenVPN on the AWS Marketplace. Any PRs which add support for a manually installed instance of OpenVPN AS are welcome.
Variables
Note: It is expected the SSL cert and key will be provided via an Ansible Vault or similar.
All of this section are passed verbatim through to sacli.
admin_ui_https_ip_address-admin_ui_https_port-aui_eula_version-auth_ldap_0_add_req-auth_ldap_0_bind_dn- Username to connect to (eg:[email protected])auth_ldap_0_bind_pw- Password to connect withauth_ldap_0_name- Friendly name of the LDAP serverauth_ldap_0_server_0_host- 1st LDAP server hostnameauth_ldap_0_server_1_host- 2nd LDAP server hostnameauth_ldap_0_ssl_verify- Should SSL be enabled. Must be one of always', 'never', 'adaptive. Defaults toalways.auth_ldap_0_timeout-auth_ldap_0_uname_attr- The Username Attribute. This is often uid for generic LDAP servers and sAMAccountName for Active Directory LDAP servers.auth_ldap_0_use_ssl- Should SSL be enabled. Must be one of always', 'never', 'adaptive. Defaults toalways.auth_ldap_0_users_base_dn- Search DN (eg:cn=Users,dc=ldap,dc=example,dc=com)auth_module_type- LDAP/Radiu/PAMauth_pam_0_service-auth_radius_0_acct_enable-auth_radius_0_name-auth_saml_0_authncontexts-auth_saml_0_enable-auth_saml_0_forceauthn-auth_saml_0_idp_cert-auth_saml_0_idp_entityid-auth_saml_0_idp_logout_endpoint-auth_saml_0_idp_signon_endpoint-auth_saml_0_requestauthncontext-auth_saml_0_sp_cert-auth_saml_0_sp_hostname-auth_saml_0_sp_key-auth_saml_0_timeout-cs_admin_only-cs_ca_bundle- The CA Bundle to use for the web servercs_cert- The TLS Certificate to use for the web servercs_cws_proto_v2-cs_cws_ui_offer_android-cs_cws_ui_offer_autologin-cs_cws_ui_offer_ios-cs_cws_ui_offer_linux-cs_cws_ui_offer_mac-cs_cws_ui_offer_server_locked-cs_cws_ui_offer_user_locked-cs_cws_ui_offer_win-cs_https_ip_address-cs_https_port-cs_priv_key- The TLS Private key to use for the web servercs_prof_sign_web-host_name-sa_initial_run_groups_0-sa_initial_run_groups_1-vpn_client_basic-vpn_client_config_text-vpn_client_routing_inter_client-vpn_client_routing_reroute_dns-vpn_client_routing_reroute_gw-vpn_daemon_0_client_netmask_bits-vpn_daemon_0_client_network-vpn_daemon_0_listen_ip_address-vpn_daemon_0_listen_port-vpn_daemon_0_listen_protocol-vpn_daemon_0_server_ip_address-vpn_server_config_text-vpn_server_daemon_enable-vpn_server_daemon_tcp_n_daemons-vpn_server_daemon_tcp_port-vpn_server_daemon_udp_n_daemons-vpn_server_daemon_udp_port-vpn_server_google_auth_enable-vpn_server_group_pool_0-vpn_server_nat_masquerade-vpn_server_port_share_enable-vpn_server_port_share_ip_address-vpn_server_port_share_port-vpn_server_port_share_service-vpn_server_routing_private_access-vpn_server_routing_private_network_0-vpn_tls_refresh_do_reauth-vpn_tls_refresh_interval-xmlrpc_relay_level-
vpn_server_dhcp_option_dns_0-vpn_server_dhcp_option_domain-
Dependencies
No dependencies
Тesting roles
Require
- ruby 2.3
- gems managed by bundler
To install gem run
bundle install
To execute testing - run kitchen command under the same folder of .kitchen.yml (By default testing driver - EC2)
kitchen test
Example Playbook
In the example below certificate.yml is an Ansible Vault, contains the cs_cert and cs_priv_key variables.
---
- hosts: openvpnas
become: true
vars:
auth_ldap_0_name: vpn.example.com
auth_ldap_0_server_0_host: ldap.example.com
auth_ldap_0_bind_dn: [email protected]
auth_ldap_0_bind_pw: superstrongpassword
auth_ldap_0_users_base_dn: cn=Users,dc=ldap,dc=example,dc=com
auth_ldap_0_uname_attr: sAMAccountName
auth_ldap_0_use_ssl: always
auth_module_type: ldap
vars_files:
- certificate.yml
roles:
- role: openvpnas
Author Information
Robin Kearney robin@kearney.co.uk
ansible-galaxy install rk295.openvpnas