InstallCerts.py Script Corrupt SDNC-ODL Keystore/Truststore
[sdnc/oam.git] / installation / sdnc / src / main / scripts / installCerts.py
index 1cc7454..354e642 100644 (file)
 
 # coding=utf-8
 import os
+import re
 import httplib
 import base64
 import time
 import zipfile
 import shutil
+import subprocess
+import logging
+
+
+log_file = '/opt/opendaylight/data/log/installCerts.log'
+with open(os.path.join('/opt/opendaylight/data/log', 'installCerts.log'), 'w') as fp:
+    pass
+
+log_format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+logging.basicConfig(filename=log_file,level=logging.DEBUG,filemode='w',format=log_format)
 
 Path = "/tmp"
 
@@ -32,21 +43,30 @@ zipFileList = []
 
 username = os.environ['ODL_ADMIN_USERNAME']
 password = os.environ['ODL_ADMIN_PASSWORD']
-timeOut=1000
-interval=30
-time=0
+TIMEOUT=1000
+INTERVAL=30
+timePassed=0
 
 postKeystore= "/restconf/operations/netconf-keystore:add-keystore-entry"
 postPrivateKey= "/restconf/operations/netconf-keystore:add-private-key"
 postTrustedCertificate= "/restconf/operations/netconf-keystore:add-trusted-certificate"
 
+truststore_pass_file = Path + '/truststore.pass'
+truststore_file = Path + '/truststore.jks'
+
+keystore_pass_file = Path + '/keystore.pass'
+keystore_file = Path + '/keystore.jks'
 
+jks_files = [truststore_pass_file, keystore_pass_file, keystore_file, truststore_file]
+
+odl_port = 8181
 headers = {'Authorization':'Basic %s' % base64.b64encode(username + ":" + password),
            'X-FromAppId': 'csit-sdnc',
            'X-TransactionId': 'csit-sdnc',
            'Accept':"application/json",
            'Content-type':"application/json"}
 
+
 def readFile(folder, file):
     key = open(Path + "/" + folder + "/" + file, "r")
     fileRead = key.read()
@@ -54,11 +74,12 @@ def readFile(folder, file):
     fileRead = "\n".join(fileRead.splitlines()[1:-1])
     return fileRead
 
+
 def readTrustedCertificate(folder, file):
     listCert = list()
     caPem = ""
     startCa = False
-    key = open(Path + "/" + folder + "/" + file, "r")
+    key = open(folder + "/" + file, "r")
     lines = key.readlines()
     for line in lines:
         if not "BEGIN CERTIFICATE" in line and not "END CERTIFICATE" in line and startCa:
@@ -71,8 +92,9 @@ def readTrustedCertificate(folder, file):
             caPem = ""
     return listCert
 
+
 def makeKeystoreKey(clientKey, count):
-    odl_private_key="ODL_private_key_%d" %count
+    odl_private_key = "ODL_private_key_%d" %count
 
     json_keystore_key='{{\"input\": {{ \"key-credential\": {{\"key-id\": \"{odl_private_key}\", \"private-key\" : ' \
                       '\"{clientKey}\",\"passphrase\" : \"\"}}}}}}'.format(
@@ -82,13 +104,12 @@ def makeKeystoreKey(clientKey, count):
     return json_keystore_key
 
 
-
 def makePrivateKey(clientKey, clientCrt, certList, count):
     caPem = ""
-    for cert in certList:
-        caPem += '\"%s\",' % cert
-
-    caPem = caPem.rsplit(',', 1)[0]
+    if certList:
+        for cert in certList:
+            caPem += '\"%s\",' % cert
+        caPem = caPem.rsplit(',', 1)[0]
     odl_private_key="ODL_private_key_%d" %count
 
     json_private_key='{{\"input\": {{ \"private-key\":{{\"name\": \"{odl_private_key}\", \"data\" : ' \
@@ -100,6 +121,7 @@ def makePrivateKey(clientKey, clientCrt, certList, count):
 
     return json_private_key
 
+
 def makeTrustedCertificate(certList, count):
     number = 0
     json_cert_format = ""
@@ -121,9 +143,10 @@ def makeRestconfPost(conn, json_file, apiCall):
     res = conn.getresponse()
     res.read()
     if res.status != 200:
-        print "Error here, response back wasnt 200: Response was : %d , %s" % (res.status, res.reason)
+        logging.error("Error here, response back wasnt 200: Response was : %d , %s" % (res.status, res.reason))
     else:
-        print res.status, res.reason
+        logging.debug("Response :%s Reason :%s ",res.status, res.reason)
+
 
 def extractZipFiles(zipFileList, count):
     for zipFolder in zipFileList:
@@ -132,59 +155,166 @@ def extractZipFiles(zipFileList, count):
         folder = zipFolder.rsplit(".")[0]
         processFiles(folder, count)
 
+
 def processFiles(folder, count):
-    conn = httplib.HTTPConnection("localhost",8181)
     for file in os.listdir(Path + "/" + folder):
         if os.path.isfile(Path + "/" + folder + "/" + file.strip()):
             if ".key" in file:
                 clientKey = readFile(folder, file.strip())
             elif "trustedCertificate" in file:
-                certList = readTrustedCertificate(folder, file.strip())
+                certList = readTrustedCertificate(Path + "/" + folder, file.strip())
             elif ".crt" in file:
                 clientCrt = readFile(folder, file.strip())
         else:
-            print "Could not find file %s" % file.strip()
+            logging.error("Could not find file %s" % file.strip())
     shutil.rmtree(Path + "/" + folder)
-    json_keystore_key = makeKeystoreKey(clientKey, count)
-    json_private_key = makePrivateKey(clientKey, clientCrt, certList, count)
-    json_trusted_cert = makeTrustedCertificate(certList, count)
+    post_content(clientKey, clientCrt, certList, count)
 
-    makeRestconfPost(conn, json_keystore_key, postKeystore)
-    makeRestconfPost(conn, json_private_key, postPrivateKey)
-    makeRestconfPost(conn, json_trusted_cert, postTrustedCertificate)
 
-def makeHealthcheckCall(headers, time):
-    conn = httplib.HTTPConnection("localhost",8181)
-    req = conn.request("POST", "/restconf/operations/SLI-API:healthcheck",headers=headers)
-    res = conn.getresponse()
-    res.read()
-    if res.status == 200:
-        print ("Healthcheck Passed in %d seconds." %time)
-    else:
-        print ("Sleep: %d seconds before testing if Healtcheck worked. Total wait time up now is: %d seconds. Timeout is: %d seconds" %(interval, time, timeOut))
-    return res.status
+def post_content(clientKey, clientCrt, certList, count):
+    conn = httplib.HTTPConnection("localhost",odl_port)
+
+    if clientKey:
+        json_keystore_key = makeKeystoreKey(clientKey, count)
+        logging.debug("Posting private key in to ODL keystore")
+        makeRestconfPost(conn, json_keystore_key, postKeystore)
 
+    if certList:
+        json_trusted_cert = makeTrustedCertificate(certList, count)
+        logging.debug("Posting trusted cert list in to ODL")
+        makeRestconfPost(conn, json_trusted_cert, postTrustedCertificate)
 
-def timeIncrement(time):
-    time.sleep(interval)
-    time = time + interval
-    return time
+    if clientKey and clientCrt and certList:
+        json_private_key = makePrivateKey(clientKey, clientCrt, certList, count)
+        logging.debug("Posting the cert in to ODL")
+        makeRestconfPost(conn, json_private_key, postPrivateKey)
 
-def healthcheck(time):
+
+def makeHealthcheckCall(headers, timePassed):
+    connected = False
     # WAIT 10 minutes maximum and test every 30 seconds if HealthCheck API is returning 200
-    while time < timeOut:
+    while timePassed < TIMEOUT:
         try:
-            status = makeHealthcheckCall(headers, time)
-            #if status == 200:
-            connected = True
-            break
+            conn = httplib.HTTPConnection("localhost",odl_port)
+            req = conn.request("POST", "/restconf/operations/SLI-API:healthcheck",headers=headers)
+            res = conn.getresponse()
+            res.read()
+            if res.status == 200:
+                logging.debug("Healthcheck Passed in %d seconds." %timePassed)
+                connected = True
+                break
+            else:
+                logging.debug("Sleep: %d seconds before testing if Healthcheck worked. Total wait time up now is: %d seconds. Timeout is: %d seconds" %(INTERVAL, timePassed, TIMEOUT))
         except:
-            print ("Sleep: %d seconds before testing if Healthcheck worked. Total wait time up now is: %d seconds. Timeout is: %d seconds" %(interval, time, timeOut))
-
-        time = timeIncrement(time)
-
-    if time > timeOut:
-        print ("TIME OUT: Healthcheck not passed in  %d seconds... Could cause problems for testing activities..." %timeOut)
+            logging.error("Cannot execute REST call. Sleep: %d seconds before testing if Healthcheck worked. Total wait time up now is: %d seconds. Timeout is: %d seconds" %(INTERVAL, timePassed, TIMEOUT))
+        timePassed = timeIncrement(timePassed)
+
+    if timePassed > TIMEOUT:
+        logging.error("TIME OUT: Healthcheck not passed in  %d seconds... Could cause problems for testing activities..." %TIMEOUT)
+    return connected
+
+
+def timeIncrement(timePassed):
+    time.sleep(INTERVAL)
+    timePassed = timePassed + INTERVAL
+    return timePassed
+
+
+def get_pass(file_name):
+    try:
+        with open(file_name, 'r') as file_obj:
+            password = file_obj.read().strip()
+        return "'{}'".format(password)
+    except Exception as e:
+        logging.error("Error occurred while fetching password : %s", e)
+        exit()
+
+
+def cleanup():
+    for file in jks_files:
+        if os.path.isfile(file):
+            logging.debug("Cleaning up the file %s", file)
+            os.remove(file)
+
+
+def jks_to_p12(file, password):
+    """Converts jks format into p12"""
+    try:
+        p12_file = file.replace('.jks', '.p12')
+        jks_cmd = 'keytool -importkeystore -srckeystore {src_file} -destkeystore {dest_file} -srcstoretype JKS -srcstorepass {src_pass} -deststoretype PKCS12 -deststorepass {dest_pass}'.format(src_file=file, dest_file=p12_file, src_pass=password, dest_pass=password)
+        logging.debug("Converting %s into p12 format", file)
+        os.system(jks_cmd)
+        file = p12_file
+        return file
+    except Exception as e:
+        logging.error("Error occurred while converting jks to p12 format : %s", e)
+
+
+def make_cert_chain(cert_chain, pattern):
+    cert_list = []
+    if cert_chain:
+        matches = re.findall(pattern, cert_chain, re.DOTALL | re.MULTILINE)
+        for cert in matches:
+            cert_list.append(cert.strip())
+        return cert_list
+    else:
+        logging.debug(" Certificate Chain empty: %s " % cert_chain)
+
+
+def process_jks_files(count):
+    ca_cert_list = []
+    logging.info("Processing JKS files found in %s directory " % Path)
+    try:
+        if all([os.path.isfile(f) for f in jks_files]):
+            keystore_pass = get_pass(keystore_pass_file)
+            keystore_file_p12 = jks_to_p12(keystore_file, keystore_pass)
+
+            client_key_cmd = 'openssl pkcs12 -in {src_file} -nocerts -nodes -passin pass:{src_pass}'.format(
+                src_file=keystore_file_p12, src_pass=keystore_pass)
+            client_crt_cmd = 'openssl pkcs12 -in {src_file} -clcerts -nokeys  -passin pass:{src_pass}'.format(
+                src_file=keystore_file_p12, src_pass=keystore_pass)
+
+            truststore_pass = get_pass(truststore_pass_file)
+            truststore_p12 = jks_to_p12(truststore_file, truststore_pass)
+
+            trust_cert_cmd = 'openssl pkcs12 -in {src_file} -cacerts -nokeys -passin pass:{src_pass} '.format(
+                src_file=truststore_p12, src_pass=truststore_pass)
+
+            key_pattern = r'(?<=-----BEGIN PRIVATE KEY-----).*?(?=-----END PRIVATE KEY-----)'
+            client_key = subprocess.check_output(client_key_cmd, shell=True)
+            if client_key:
+                client_key = make_cert_chain(client_key, key_pattern)[0]
+                logging.debug("Key Ok")
+
+            cert_pattern = r'(?<=-----BEGIN CERTIFICATE-----).*?(?=-----END CERTIFICATE-----)'
+            client_cert = subprocess.check_output(client_crt_cmd, shell=True)
+            if client_cert:
+                client_cert = make_cert_chain(client_cert, cert_pattern)[0]
+                logging.debug("Client Cert Ok")
+
+            ca_cert = subprocess.check_output(trust_cert_cmd, shell=True)
+            if ca_cert:
+                ca_cert_list = make_cert_chain(ca_cert, cert_pattern)
+                logging.debug("CA Cert Ok")
+
+            if client_key and client_cert and ca_cert:
+                post_content(client_key, client_cert, ca_cert_list, count)
+        else:
+            logging.debug("No JKS files found in %s directory" % Path)
+    except subprocess.CalledProcessError as err:
+        print("CalledProcessError Execution of OpenSSL command failed: %s" % err)
+    except Exception as e:
+        logging.error("UnExpected Error while processing JKS files at {0}, Caused by: {1}".format(Path, e))
+
+
+def readCertProperties():
+    '''
+    This function searches for manually copied zip file
+    containing certificates. This is required as part
+    of backward compatibility.
+    If not foud, it searches for jks certificates.
+    '''
+    connected = makeHealthcheckCall(headers, timePassed)
 
     if connected:
         count = 0
@@ -198,9 +328,8 @@ def healthcheck(time):
                         count += 1
                         del zipFileList[:]
         else:
-            print "Error: File not found in path entered"
-    else:
-        print "This was a problem here, Healthcheck never passed, please check is your instance up and running."
+            logging.debug("No certs.properties/zip files exist at: " + Path)
+            process_jks_files(count)
 
 
-healthcheck(time)
+readCertProperties()
\ No newline at end of file