1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2020 Nordix Foundation.
3 # ================================================================================
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # SPDX-License-Identifier: Apache-2.0
17 # ============LICENSE_END=========================================================
19 __author__ = "Ajay Deep Singh (ajay.deep.singh@est.tech)"
20 __copyright__ = "Copyright (C) 2020 Nordix Foundation"
21 __license__ = "Apache 2.0"
28 from OpenSSL import crypto
29 from docker.types import Mount
31 DEV_NULL = open(os.devnull, 'wb')
32 NETCONF_PNP_SIM_CONTAINER_NAME = 'netconf-simulator'
33 ARCHIVES_PATH = os.getenv("WORKSPACE") + "/archives/"
38 def __init__(self, mount_path, truststore_path):
39 self.mount_path = mount_path
40 self.truststore_path = truststore_path
41 self.keyPem = mount_path + '/key.pem'
42 self.caCertPem = mount_path + '/ca.pem'
43 self.serverKeyPem = mount_path + '/server_key.pem'
44 self.serverCertPem = mount_path + '/server_cert.pem'
45 self.keystorePemPath = mount_path + '/keystore.pem'
46 self.keystoreP12Path = mount_path + '/keystore.p12'
47 self.keystorePassPath = mount_path + '/keystore.pass'
48 self.truststorePemPath = mount_path + '/truststore.pem'
49 self.truststoreP12Path = mount_path + '/truststore.p12'
50 self.truststorePassPath = mount_path + '/truststore.pass'
52 # Function Create docker container.
53 def run_client_container(self, client_image, container_name, path_to_env, request_url, network):
54 self.create_mount_dir()
55 client = docker.from_env()
56 environment = self.read_env_list_from_file(path_to_env)
57 environment.append("REQUEST_URL=" + request_url)
58 container = client.containers.run(
61 environment=environment,
64 mounts=[Mount(target='/var/certs', source=self.mount_path, type='bind'),
65 Mount(target='/etc/onap/aaf/certservice/certs/', source=self.truststore_path, type='bind')],
68 exitcode = container.wait()
71 # Function to validate keystore/truststore can be opened with generated pass-phrase.
72 def can_open_keystore_and_truststore_with_pass(self, container_name):
73 if container_name != NETCONF_PNP_SIM_CONTAINER_NAME:
74 return self.can_open_keystore_and_truststore_pem_files()
76 return self.can_open_keystore_and_truststore_p12_files()
78 # Function to validate keystore.pem/truststore.pem exist and are not empty.
79 def can_open_keystore_and_truststore_pem_files(self):
81 private_key = self.file_exist_and_not_empty(self.keyPem)
82 keystore_pem = self.file_exist_and_not_empty(self.keystorePemPath)
83 truststore_pem = self.file_exist_and_not_empty(self.truststorePemPath)
84 return private_key and keystore_pem and truststore_pem
85 except Exception as e:
86 print("UnExpected Error in validating keystore.pem/truststore.pem: {0}".format(e))
89 # Function to validate keystore.p12/truststore.p12 can be opened with generated pass-phrase.
90 def can_open_keystore_and_truststore_p12_files(self):
91 can_open_keystore = self.can_open_p12_file_with_pass_file(self.keystorePassPath, self.keystoreP12Path)
92 can_open_truststore = self.can_open_p12_file_with_pass_file(self.truststorePassPath, self.truststoreP12Path)
93 return can_open_keystore & can_open_truststore
95 # Method for Uploading Certificate in SDNC-Container.
96 # Creating/Uploading Server-key, Server-cert, Ca-cert PEM files in Netconf-Pnp-Simulator.
97 def can_install_keystore_and_truststore_certs(self, cmd, cmd_tls, container_name):
99 if container_name == NETCONF_PNP_SIM_CONTAINER_NAME:
100 print("Generating PEM files for {0} from P12 files".format(container_name))
101 continue_exec = self.create_pem(self.keystorePassPath, self.keystoreP12Path, self.truststorePassPath,
102 self.truststoreP12Path)
106 print("Initiate Configuration Push for : {0}".format(container_name))
107 resp_code = self.execute_bash_config(cmd, container_name)
109 print("Execution Successful for: {0}".format(container_name))
112 print("Execution Failed for: {0}".format(container_name))
115 def create_pem(self, keystore_pass_path, keystore_p12_path, truststore_pass_path, truststore_p12_path):
116 # Create [server_key.pem, server_cert.pem, ca.pem] files for Netconf-Pnp-Simulation/TLS Configuration.
118 with open(self.serverKeyPem, "wb+") as key_file:
119 key_file.write(crypto.dump_privatekey(crypto.FILETYPE_PEM,
120 self.get_pkcs12(keystore_pass_path,
121 keystore_p12_path).get_privatekey()))
122 with open(self.serverCertPem, "wb+") as server_cert_file:
123 server_cert_file.write(crypto.dump_certificate(crypto.FILETYPE_PEM,
124 self.get_pkcs12(keystore_pass_path,
125 keystore_p12_path).get_certificate()))
126 with open(self.caCertPem, "wb+") as ca_cert_file:
128 crypto.dump_certificate(crypto.FILETYPE_PEM,
129 self.get_pkcs12(truststore_pass_path,
130 truststore_p12_path).get_ca_certificates()[0]))
132 except IOError as err:
133 print("I/O Error: {0}".format(err))
135 except Exception as e:
136 print("UnExpected Error: {0}".format(e))
139 def can_open_p12_file_with_pass_file(self, pass_file_path, p12_file_path):
141 if p12_file_path.split('/')[-1] == 'truststore.p12':
142 pkcs12 = self.get_pkcs12(pass_file_path, p12_file_path).get_ca_certificates()[0]
144 pkcs12 = self.get_pkcs12(pass_file_path, p12_file_path).get_certificate()
148 except IOError as err:
149 print("I/O Error PKCS12 Creation failed: {0}".format(err))
151 except Exception as e:
152 print("UnExpected Error PKCS12 Creation failed: {0}".format(e))
155 def remove_client_container_and_save_logs(self, container_name, log_file_name):
156 client = docker.from_env()
157 container = client.containers.get(container_name)
158 text_file = open(ARCHIVES_PATH + container_name + '_' + log_file_name + ".log", "w")
159 text_file.write(container.logs())
162 self.remove_mount_dir()
164 def create_mount_dir(self):
165 if not os.path.exists(self.mount_path):
166 os.makedirs(self.mount_path)
168 def remove_mount_dir(self):
169 shutil.rmtree(self.mount_path)
171 def file_exist_and_not_empty(self, path_to_file):
172 return os.path.isfile(path_to_file) and os.path.getsize(path_to_file) > 0
175 def get_pkcs12(pass_file_path, p12_file_path):
177 password = open(pass_file_path, 'rb').read()
178 return crypto.load_pkcs12(open(p12_file_path, 'rb').read(), password)
181 def execute_bash_config(cmd, container_name):
182 # Run command with arguments. Wait for command to complete or timeout, return code attribute.
184 resp_code = subprocess.call(["%s %s" % (cmd, container_name)], shell=True, stdout=DEV_NULL,
185 stderr=subprocess.STDOUT)
186 print("Response Code from Config.sh execution: {0}".format(resp_code))
188 except subprocess.CalledProcessError as e:
189 print("CalledProcessError Certificate installation failed in SDNC-ODL Container: {0}".format(e))
190 return 1 # Return Error Code
193 def get_container_logs(container_name):
194 client = docker.from_env()
195 container = client.containers.get(container_name)
196 logs = container.logs()
200 def read_env_list_from_file(path):