-
-
Save diepes/a7c3a53ed94c587803e20e6576ea4525 to your computer and use it in GitHub Desktop.
This is a python script to generate client OpenVPN configuration files. This is based mostly on the easyrsa script and is much simpler to understand.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
*.swp | |
#dont upload secret material to git | |
*.crt | |
*.key | |
*.ovpn | |
*.ovpn.conf | |
*.conf | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#ovpn-common.jinja2 - CN={{ CN }} | |
#PES 2018-07-12 template | |
verb 3 | |
dev-type tap | |
dev {{ tap_interface_name }} | |
#Azure-vpn-vm=13.73.199.180 | |
#Azure-ras-vm=13.75.221.215 | |
{% if is_server %} | |
## SERVER name:"{{ this_server['name'] }}" | |
##Hand out ip's for tunnel from ip_pool | |
#server {{ this_server[ 'ip_pool' ] }} | |
mode server | |
ifconfig {{ this_server['vpn_ip'] }} {{ this_server['vpn_mask'] }} | |
#client-to-client | |
tls-server | |
remote-cert-tls client | |
##Note: https://community.openvpn.net/openvpn/wiki/Hardening#Useof--tls-auth | |
#key-direction 0 | |
tls-auth [inline] 0 | |
#client-config-dir ccd | |
# # iroute | |
#ifconfig-pool-persist ipp.txt | |
#to limit mtu issues, tap + encryption. | |
mssfix 1400 | |
#Add client routes to the server | |
route-metric 100 | |
{% for client in vpn_clients %} | |
# Client {{ client['client']['count'] }} name: {{ client['client']['name'] }} | |
{% for subnet in client['client']['subnets'] %} | |
route {{ subnet }} {{ client['client']['vpn_ip'] }} | |
{% endfor %} | |
{% endfor %}{# end client routes #} | |
{% else %}{# /server #} | |
## CLIENT #name:{{ this_client['name'] }} | |
client | |
nobind | |
remote-random | |
#Static client ip's | |
ifconfig {{ this_client['vpn_ip'] }} {{ this_client['vpn_mask'] }} | |
route-metric 100 | |
{% for server in vpn_servers %} | |
{% set s = server['server'] %} | |
<connection> # {{ s['name'] }} | |
remote {{ s['connect'] }} | |
# tls-remote <CN> | |
</connection> | |
# Add routes to client for the specific server | |
{% if "subnets_local" in s %} | |
{% for subnet in s['subnets_local'] %} | |
route {{ subnet }} {{ this_server['vpn_ip'] }} | |
{% endfor %} | |
{% endif %} | |
{% endfor %} | |
tls-client | |
#only allow certs issued to server's | |
remote-cert-tls server | |
#ns-cert-type server | |
##Note: https://community.openvpn.net/openvpn/wiki/Hardening#Useof--tls-auth | |
#key-direction 1 | |
tls-auth [inline] 1 | |
{% endif %}{# /client #} | |
#From v2.4 tls-crypt can be used | |
cipher AES-256-CBC | |
comp-lzo | |
#compress lzo | |
keepalive 10 60 | |
ping-timer-rem | |
persist-tun | |
persist-key | |
user nobody | |
group nogroup | |
daemon | |
<ca> | |
{{ cacert }} | |
</ca> | |
#cert CN="{{ CN }}" | |
<cert> | |
{{ clientcert }} | |
</cert> | |
#key CN="{{ CN }}" | |
<key> | |
{{ clientkey }} | |
</key> | |
<tls-auth> | |
{{ tlsauth_key }} | |
</tls-auth> | |
<dh> | |
{{ dh }} | |
</dh> | |
#THE END. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
-----BEGIN DH PARAMETERS----- | |
MIICCAKCAgEA/abPvuLzKLl3VagQSvsDbTXZaFV7HfQA5XhDW/8ZnBFnMLfSkl+i | |
/QcGGJnhZQGFi/O7ucsSOGHAy5CsTFUqltZdXR+GxHRmMJ4HcqnOaS3/F4abGhZY | |
KxIMLnVaINijo7hILVASIvleozJv1MoNi37yg4EEfoZTm2m9aAkyFXpdvpcJJ/N7 | |
9F0OP4gzhgBNx0q0wGJ9AHUrhdH2D+EGtV68FxK8Z+ZOSKHD9qqY9Xhpy0C7dApO | |
nRoFexSWXS0vAHMB6VTTTGDllolhKeSBYH/YUiocWVBRtoJImCk3VbfYy1SXtZpP | |
2p+W7qoYXx3GcnLMI87QBZCkJTDmIxr0waZ0JyuWA7WYIFofJTWyWOSTOFjEBQVV | |
BpdiyXPFBjWPyqj++IW+HbnBavrjzpkeBQ9nHYhs+U6oIf5KCKSCPui43jhXiPNT | |
2pPmjZtWxcnhMkC7QEUfLMsxbC4bUV4eMk6QZdOGFJ9PVg/YODVQjW7BtW+eNIqb | |
sJjAGdhVoIdLUbn7cX7TvIYf6TVwLlZqcCOLBWb9ZJSeNl8HYCe1COUvTuXU7wSD | |
8VfPWoQtJTL1B8rX71rT7Oies6dr+mofTM5Vd/w3Pw6S685Wzx/7lwJefGSbGZpC | |
OBwHEMikBE2lO3apSF7rnLBXhUrPmVlttZkIH/tU9KOBlm8vf4s1qYsCAQI= | |
-----END DH PARAMETERS----- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env python3 | |
import os | |
import socket | |
from OpenSSL import crypto, SSL | |
import datetime | |
import subprocess | |
import random | |
import jinja2 | |
import ipaddress | |
# | |
import argparse, logging, sys | |
# | |
import yaml | |
import re | |
# logging level set with -v flag | |
logging.basicConfig(level=logging.INFO,format='[%(levelname)-5s :%(lineno)s-%(funcName)s()] %(message)s') | |
logging.warning("Start!") | |
# | |
''' PES clone 2018-07-12 | |
''' | |
# OpenVPN is fairly simple since it works on OpenSSL. The OpenVPN server contains | |
# a root certificate authority that can sign sub-certificates. The certificates | |
# have very little or no information on who they belong to besides a filename | |
# and any required information. Everything else is omitted or blank. | |
# The client certificate and private key are inserted into the .ovpn file | |
# which contains some settins as well and the entire thing is then ready for | |
# the user. | |
# EasyRSA generates a standard unsigned certificate, certificate request, and private key. | |
# It then signs the certificate against the CA then dumps the certificate request in the trash. | |
# The now signed certificate and private key are returned. | |
# Create a new keypair of specified algorithm and number of bits. | |
def make_keypair(algorithm=crypto.TYPE_RSA, numbits=2048): | |
logging.debug(f" algorithm={algorithm} , numbits={numbits}") | |
pkey = crypto.PKey() | |
pkey.generate_key(algorithm, numbits) | |
return pkey | |
# Creates a certificate signing request (CSR) given the specified subject attributes. | |
def make_csr(pkey, CN, C=None, ST=None, L=None, O=None, OU=None, emailAddress=None, hashalgorithm='sha256WithRSAEncryption'): | |
req = crypto.X509Req() | |
req.get_subject() | |
subj = req.get_subject() | |
if C: | |
subj.C = C | |
if ST: | |
subj.ST = ST | |
if L: | |
subj.L = L | |
if O: | |
subj.O = O | |
if OU: | |
subj.OU = OU | |
if CN: | |
subj.CN = CN | |
if emailAddress: | |
subj.emailAddress = certemailAddress | |
req.set_pubkey(pkey) | |
req.sign(pkey, hashalgorithm) | |
return req | |
# Create a certificate authority (if we need one) | |
def create_ca(CN, C="", ST="", L="", O="", OU="", emailAddress="", hashalgorithm='sha256WithRSAEncryption', keysize=2048 ): | |
cakey = make_keypair(numbits=keysize) | |
careq = make_csr(cakey, CN=CN) | |
cacert = crypto.X509() | |
cacert.set_serial_number(0) | |
cacert.gmtime_adj_notBefore(0) | |
cacert.gmtime_adj_notAfter(60*60*24*365*10) # 10 yrs - hard to beat this kind of cert! | |
cacert.set_issuer(careq.get_subject()) | |
cacert.set_subject(careq.get_subject()) | |
cacert.set_pubkey(careq.get_pubkey()) | |
cacert.set_version(2) | |
# Set the extensions in two passes | |
#PES change critical flag True->False for subjectKeyIdentifier | |
cacert.add_extensions([ | |
crypto.X509Extension(b'basicConstraints', True,b'CA:TRUE'), | |
crypto.X509Extension(b'subjectKeyIdentifier' , False , b'hash', subject=cacert) | |
]) | |
# ... now we can set the authority key since it depends on the subject key | |
cacert.add_extensions([ | |
crypto.X509Extension(b'authorityKeyIdentifier' , False, b'issuer:always, keyid:always', issuer=cacert, subject=cacert) | |
]) | |
cacert.sign(cakey, hashalgorithm) | |
return (cacert, cakey) | |
# Create a new slave cert. | |
def create_slave_certificate(csr, cakey, cacert, serial, is_server): | |
cert = crypto.X509() | |
cert.set_serial_number(serial) | |
cert.gmtime_adj_notBefore(0) | |
cert.gmtime_adj_notAfter(60*60*24*365*10) # 10 yrs - hard to beat this kind of cert! | |
cert.set_issuer(cacert.get_subject()) | |
cert.set_subject(csr.get_subject()) | |
cert.set_pubkey(csr.get_pubkey()) | |
cert.set_version(2) | |
extensions = [] | |
extensions.append(crypto.X509Extension(b'basicConstraints', False ,b'CA:FALSE')) | |
extensions.append(crypto.X509Extension(b'subjectKeyIdentifier' , False , b'hash', subject=cert)) | |
extensions.append(crypto.X509Extension(b'authorityKeyIdentifier' , False, b'keyid:always,issuer:always', subject=cacert, issuer=cacert)) | |
if is_server: | |
extensions.append(crypto.X509Extension(b"keyUsage", False, b"digitalSignature,keyEncipherment")) | |
extensions.append(crypto.X509Extension(b"extendedKeyUsage", False, b"serverAuth")) #openvpn remote-cert-tls server | |
extensions.append(crypto.X509Extension(b"nsCertType", False, b"server")) | |
else: | |
extensions.append(crypto.X509Extension(b"keyUsage", False, b"digitalSignature")) | |
extensions.append(crypto.X509Extension(b"extendedKeyUsage", False, b"clientAuth")) | |
extensions.append(crypto.X509Extension(b"nsCertType", False, b"client")) | |
cert.add_extensions(extensions) | |
cert.sign(cakey, 'sha256WithRSAEncryption') | |
return cert | |
# Dumps content to a string | |
def dump_file_in_mem(material, format=crypto.FILETYPE_PEM): | |
dump_func = None | |
if isinstance(material, crypto.X509): | |
dump_func = crypto.dump_certificate | |
elif isinstance(material, crypto.PKey): | |
dump_func = crypto.dump_privatekey | |
elif isinstance(material, crypto.X509Req): | |
dump_func = crypto.dump_certificate_request | |
else: | |
raise Exception("Don't know how to dump content type to file: %s (%r)" % (type(material), material)) | |
return dump_func(format, material) | |
# Loads the file into the appropriate openssl object type. | |
def load_from_file(materialfile, objtype, format=crypto.FILETYPE_PEM): | |
if objtype is crypto.X509: | |
load_func = crypto.load_certificate | |
elif objtype is crypto.X509Req: | |
load_func = crypto.load_certificate_request | |
elif objtype is crypto.PKey: | |
load_func = crypto.load_privatekey | |
else: | |
raise Exception("Unsupported material type: %s" % (objtype,)) | |
with open(materialfile, 'r') as fp: | |
buf = fp.read() | |
material = load_func(format, buf) | |
return material | |
def retrieve_key_from_file(keyfile): | |
return load_from_file(keyfile, crypto.PKey) | |
def retrieve_csr_from_file(csrfile): | |
return load_from_file(csrfile, crypto.X509Req) | |
def retrieve_cert_from_file(certfile): | |
return load_from_file(certfile, crypto.X509) | |
####################################################################### | |
def make_new_ovpn_file(ca_cert, ca_key, tlsauth_key, dh, CN, serial | |
, commonoptspath, filepath | |
, keysize=2048 | |
, is_server=False | |
, vpn_servers=None, this_server=None | |
, vpn_clients=None, this_client=None | |
, tap_interface_name="tap_az"): | |
''' Make config template ''' | |
# Read our common options file first | |
f = open(commonoptspath, 'r') | |
common = f.read() | |
f.close() | |
#ca_cert = retrieve_cert_from_file(ca_cert) | |
#ca_key = retrieve_key_from_file(ca_key) | |
# Generate a new private key pair for a new certificate. | |
key = make_keypair(numbits=keysize) | |
# Generate a certificate request | |
csr = make_csr(key, CN) | |
# Sign the certificate with the new csr | |
crt = create_slave_certificate(csr, ca_key, ca_cert, serial, is_server=is_server) | |
# Now we have a successfully signed certificate. We must now | |
# create a .ovpn file and then dump it somewhere. | |
clientkey = dump_file_in_mem(key) | |
clientcert = dump_file_in_mem(crt) | |
cacertdump = dump_file_in_mem(ca_cert) | |
logging.debug(f"is_server={is_server} this_server={this_server} this_client={this_client}") | |
j2_env = jinja2.Environment( | |
loader=jinja2.FileSystemLoader(os.path.dirname(os.path.abspath(__file__))) | |
, trim_blocks=True ) | |
ovpn = j2_env.get_template(commonoptspath).render( | |
title='Hellow Gist from GutHub', | |
is_server=is_server, | |
CN=CN, | |
cacert=cacertdump.decode('ascii').strip(), | |
clientcert=clientcert.decode('ascii').strip(), | |
clientkey=clientkey.decode('ascii').strip(), | |
tlsauth_key=tlsauth_key.strip(), | |
dh=dh.strip(), | |
vpn_servers=vpn_servers, | |
vpn_clients=vpn_clients, | |
this_server=this_server, | |
this_client=this_client, | |
tap_interface_name=tap_interface_name | |
) | |
# Write our file. | |
f = open(filepath, 'wt') | |
f.write(ovpn) | |
f.close() | |
def create_ca_if_missing(ca_name="ca",keysize=2048 ): | |
'''not used ''' | |
exit(1) | |
#create_ca(CN, C="", ST="", L="", O="", OU="", emailAddress="", hashalgorithm='sha256WithRSAEncryption'): | |
cacert, cakey = create_ca(CN=f"{ca_name}", C="New Zealand", ST="Auckland", O="NSP", OU="IT", keysize=keysize) | |
open(f"./{ca_name}.crt", "wb").write(dump_file_in_mem(cacert)) | |
open(f"./{ca_name}.key", "wb").write(dump_file_in_mem(cakey)) | |
def gen_tlsauth_key(): | |
"""Generate an openvpn secret key by calling openvpn. Returns a string.""" | |
cmd = ['openvpn', '--genkey', '--secret', 'ta.tmp'] | |
ret = subprocess.check_call(cmd) | |
with open('ta.tmp') as key: | |
key = key.read() | |
os.remove('ta.tmp') | |
return key | |
def gen_dhparam_dh(filename='openvpn_dh4096.dh'): | |
"""Generate an diffie hellman key by calling openssl. Returns a string.""" | |
if not os.path.isfile(filename): | |
cmd = [rf'/usr/bin/openssl dhparam -out {filename} 4096 2>/dev/null'] | |
ret = subprocess.check_call(cmd) | |
with open(filename) as key: | |
key = key.read() | |
#os.remove('dh4096.tmp') | |
return key | |
def get_args(): | |
parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter) | |
parser.add_argument("-c", "--config", dest="config", type=str, | |
default="openvpn_sample.conf.yaml", | |
help="set config in yaml file" | |
) | |
parser.add_argument("-v", "--verbose", dest="verbose", action="count", | |
default=0, | |
help="increase output verbosity" | |
) | |
parser.add_argument("--template", dest="template", nargs='?', type=str, | |
default="openvpn_common.jinja2", | |
help="template to deploy on azure." | |
) | |
parser.add_argument("-p", "--prefix", dest="prefix", type=str, | |
help="prefix name for openvpn configs." | |
) #, nargs='?' | |
parser.add_argument("--keysize", dest="keysize", nargs='?', type=int, | |
default=2048, choices =[ 2048, 4096 ], | |
help="rsa key size. 2048 fine, 4096 possible." | |
) | |
parser.add_argument("--count-client", dest="count_client", nargs='?', type=int, | |
default=3, | |
help="number of client templates." | |
) | |
parser.add_argument("--count-server", dest="count_server", nargs='?', type=int, | |
default=2, | |
help="number of server templates." | |
) | |
args = parser.parse_args() | |
if args.verbose == 1: | |
log=logging.getLogger() | |
log.setLevel(logging.INFO) | |
logging.info(f"set logging.level to INFO verbose={args.verbose}") | |
if args.verbose > 1: | |
log=logging.getLogger() | |
log.setLevel(logging.DEBUG) | |
logging.debug(f"set logging.level to DEBUG verbose={args.verbose}") | |
logging.debug(f"sys.argv[0]={sys.argv[0]} ,args={args}") | |
if os.path.isfile(args.config): | |
with open(args.config, 'r') as ymlfile: | |
cfg = yaml.load(ymlfile) | |
logging.info(f"loaded config from {args.config}") | |
logging.debug(f"config from {args.config} is: {cfg}") | |
#if cfg has prefix, but none passed in args, prevent prefix=None | |
if ( 'prefix' in cfg ) and ( not args.prefix ): args.prefix = cfg['prefix'] | |
else: | |
logging.warn(f"missing config file {args.config}") | |
cfg = dict() | |
cfg['network']=ipaddress.ip_network(re.sub( r'\s+','/', cfg['vpn_config']['ip_subnet'].strip() )) | |
#Note: vars changes the namespace to a dict, **x, **y merge dicts | |
return { **cfg , **vars(args) } | |
def main(): | |
args = get_args() | |
#print(args['network'].network_address) | |
#print(args['network'].network_address+1) | |
#print(args['network'].netmask) | |
logging.debug(f"__main___ args={args}") | |
#commonoptspath=args["template"] | |
tn = datetime.datetime.now().strftime("%Y%m%d_%Hh%M") | |
ca_name=f"{args['prefix']}_{tn}_ca" | |
#create_ca_if_missing(ca_name=ca_name) | |
ca_cert, ca_key = create_ca( CN=f"{ca_name}" | |
,C="New Zealand" | |
,ST="Auckland" | |
,O="NSP" | |
,OU="IT" | |
,keysize=args['keysize'] ) | |
tlsauth_key=gen_tlsauth_key() | |
dh=gen_dhparam_dh() | |
#First loop client to get count | |
if not "vpn_clients" in args.keys(): | |
args['vpn_clients']=[ {'client': {'name':'DummyClient'} }, ] | |
logging.info("no clients found in config creating a dummy config.") | |
for c, client in enumerate(args['vpn_clients'], 1): | |
client['client']['count'] = c | |
client['client']['vpn_ip'] = args['network'].network_address +10 +c #Start @11 | |
client['client']['vpn_mask']= args['network'].netmask | |
#remove illegal chars from file name. | |
name=re.sub( r'\s+|\\|/|:|_','', client['client']['name'] ).lower() | |
make_new_ovpn_file(ca_cert=ca_cert, ca_key=ca_key, | |
tlsauth_key=tlsauth_key, dh=dh, | |
CN=f"{args['prefix']}_{tn}_client_{c}_{name}", serial=random.randint(100, 99999999), | |
commonoptspath=args['template'], | |
filepath=f"{args['prefix']}_{tn}_client_{c}_{name}.ovpn.conf", | |
vpn_servers=args['vpn_servers'], | |
vpn_clients=args['vpn_clients'], | |
this_client=client['client'], | |
this_server={ 'vpn_ip' : args['network'].network_address +1 }, | |
tap_interface_name=args['tap_interface_name'] | |
) | |
#2nd Loop servers. | |
if not "vpn_servers" in args.keys(): | |
args['vpn_servers']=[ {'server': {'name':'Dummy', 'connect': '10.0.0.1 1194 udp' , 'ip_pool' : 'N.A'}}, ] | |
logging.info("no servers found in config creating a dummy config.") | |
for c,server in enumerate(args['vpn_servers'], 1): #create 2 server certs | |
server['server']['count']=c | |
server['server']['vpn_ip'] = args['network'].network_address +1 | |
server['server']['vpn_mask']= args['network'].netmask | |
#remove illegal chars from file name. | |
name=re.sub( r'\s+|\\|/|:|_','', server['server']['name'] ).lower() | |
logging.debug(f"... creating server config c={c} {name} server={server['server']}") | |
make_new_ovpn_file(is_server=True, | |
ca_cert=ca_cert, ca_key=ca_key, | |
tlsauth_key=tlsauth_key, dh=dh, | |
CN=f"{args['prefix']}_{tn}_server_{c}_{name}", serial=random.randint(1, 99), | |
commonoptspath=args['template'], filepath=f"{args['prefix']}_{tn}_server_{c}_{name}.ovpn.conf", | |
vpn_servers=args['vpn_servers'], | |
vpn_clients=args['vpn_clients'], | |
this_server=server['server'], | |
tap_interface_name=args['tap_interface_name'] | |
) | |
if __name__ == "__main__": | |
main() | |
print("Done") | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment