| 1 |
--- |
| 2 |
# Example of installing a SSL certificate in ONTAP for authentication |
| 3 |
# This playbook: |
| 4 |
# 1. installs the certificate, or proceeds if the certificate is already installed, |
| 5 |
# 2. enables SSL client authentication, |
| 6 |
# 3. creates user account for cert authentication for ontapi and http applications, |
| 7 |
# 4. validates that cert authentication works |
| 8 |
# |
| 9 |
# in test mode (using tags: -t all,testpb): |
| 10 |
# 1b. the installation is repeated, to validate the check for idempotency (certificate already installed), |
| 11 |
# 5. user account for cert authentication for ontapi and http applications is deleted, |
| 12 |
# 6. if the certificate was installed in step 1, it is deleted. |
| 13 |
# The certificate can be manually deleted using something like: |
| 14 |
# security certificate delete -vserver trident_svm -common-name cert_user -ca cert_user -type * |
| 15 |
# |
| 16 |
# Prerequisites: |
| 17 |
# you must have generated a certificate and have the certificate file (.pem) and the private key file available. |
| 18 |
# This was tested using a self signed certificate: |
| 19 |
# https://netapp.io/2016/11/08/certificate-based-authentication-netapp-manageability-sdk-ontap/ |
| 20 |
- name: Ontap Install SSL certificate and enable SSL certificate authentication |
| 21 |
hosts: localhost |
| 22 |
gather_facts: false |
| 23 |
vars: |
| 24 |
# TODO: change these variable values from HERE to DONE: |
| 25 |
ontap_admin_ip: 10.XXX.XXX.X19 |
| 26 |
ontap_admin_username: admin |
| 27 |
ontap_admin_password: XXXXXXXX |
| 28 |
# we recommend to use https, but it requires a valid SSL certificate |
| 29 |
ontap_use_https: true |
| 30 |
ontap_validate_certs: false |
| 31 |
|
| 32 |
# parameters to set up the certificate, ontap_cert_user must match the value of CN= when generating the certificate |
| 33 |
ontap_cert_user: cert_user |
| 34 |
ontap_cert_name: deleteme_cert |
| 35 |
# admin or vsadmin |
| 36 |
ontap_cert_role: vsadmin |
| 37 |
# admin or data SVM |
| 38 |
vserver: trident_svm |
| 39 |
# admin or SVM IP address (for admin, would the same as ontap_admin_ip) |
| 40 |
ontap_svm_ip: 10.XXX.XXX.X21 |
| 41 |
# certificate and private key files |
| 42 |
cert_filepath: /home/laurentn/atelier/ansible_wsl/ansible-playbooks/test.pem |
| 43 |
key_filepath: /home/laurentn/atelier/ansible_wsl/ansible-playbooks/test.key |
| 44 |
# set this to false if the certificate is self-signed |
| 45 |
validate_certs_for_ssl_auth: false |
| 46 |
|
| 47 |
# you can either copy/paste the certificate(s) from the pem file, respecting the identation: |
| 48 |
ssl_certificate_inline: | |
| 49 |
-----BEGIN CERTIFICATE----- |
| 50 |
MXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 51 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 52 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 53 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 54 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 55 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 56 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 57 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 58 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 59 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 60 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 61 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 62 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 63 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 64 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 65 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 66 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 67 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxx |
| 68 |
XXXXXXXXxxxxxxxxXXXXXXXXxxxxxxxxXXXXXXXXxx== |
| 69 |
-----END CERTIFICATE----- |
| 70 |
|
| 71 |
# or read it directly from the pem file |
| 72 |
ssl_certificate_from_file: "{{lookup('file', cert_filepath)}}" |
| 73 |
|
| 74 |
# pick one: |
| 75 |
# ssl_certificate: "{{ ssl_certificate_inline }}" |
| 76 |
ssl_certificate: "{{ ssl_certificate_from_file }}" |
| 77 |
|
| 78 |
# DONE - do not change anything else (unless you really want to) |
| 79 |
|
| 80 |
# this will be used to authenticate using SSL certificate |
| 81 |
cert_login: &cert_login |
| 82 |
hostname: "{{ ontap_svm_ip }}" |
| 83 |
cert_filepath: "{{ cert_filepath }}" |
| 84 |
key_filepath: "{{ key_filepath }}" |
| 85 |
https: true |
| 86 |
validate_certs: "{{ validate_certs_for_ssl_auth }}" |
| 87 |
|
| 88 |
login: &login |
| 89 |
hostname: "{{ ontap_admin_ip }}" |
| 90 |
username: "{{ ontap_admin_username }}" |
| 91 |
password: "{{ ontap_admin_password }}" |
| 92 |
https: "{{ ontap_use_https }}" |
| 93 |
validate_certs: "{{ ontap_validate_certs }}" |
| 94 |
|
| 95 |
tasks: |
| 96 |
- name: Run ontap info module to check connectivity |
| 97 |
netapp.ontap.na_ontap_info: |
| 98 |
<<: *login |
| 99 |
gather_subset: ontap_system_version |
| 100 |
register: ontap |
| 101 |
- name: Print info |
| 102 |
ansible.builtin.debug: |
| 103 |
var: ontap.ontap_info.ontap_version |
| 104 |
|
| 105 |
- name: Use ZAPIT to install certificate |
| 106 |
netapp.ontap.na_ontap_zapit: |
| 107 |
<<: *login |
| 108 |
zapi: |
| 109 |
security-certificate-install: |
| 110 |
cert-name: "{{ ontap_cert_name }}" |
| 111 |
certificate: "{{ ssl_certificate }}" |
| 112 |
type: client-ca |
| 113 |
vserver: "{{ vserver }}" |
| 114 |
ignore_errors: true |
| 115 |
register: ontap |
| 116 |
- name: Print info |
| 117 |
ansible.builtin.debug: |
| 118 |
var: ontap |
| 119 |
- name: Fail module |
| 120 |
ansible.builtin.fail: |
| 121 |
msg: "Failed to install certificate: {{ ontap }}" |
| 122 |
when: ontap.failed and ontap.reason != "duplicate entry" |
| 123 |
- name: Collect certificate data to be able to delete it later when testing |
| 124 |
tags: never,testpb |
| 125 |
ansible.builtin.set_fact: |
| 126 |
certificate_authority: "{{ ontap.response.ca | default('unknown') }}" |
| 127 |
serial_number: "{{ ontap.response.serial | default(0) }}" |
| 128 |
certificate_installed: "{{ not ontap.failed }}" |
| 129 |
- name: Print info |
| 130 |
ansible.builtin.debug: |
| 131 |
var: certificate_authority |
| 132 |
tags: never,testpb |
| 133 |
- name: Print info |
| 134 |
ansible.builtin.debug: |
| 135 |
var: serial_number |
| 136 |
tags: never,testpb |
| 137 |
- name: Print info |
| 138 |
ansible.builtin.debug: |
| 139 |
var: certificate_installed |
| 140 |
tags: never,testpb |
| 141 |
|
| 142 |
- name: Use ZAPIT to install certificate (idempotency) |
| 143 |
# use -t all,testpb when testing the playbook |
| 144 |
tags: never,testpb |
| 145 |
netapp.ontap.na_ontap_zapit: |
| 146 |
<<: *login |
| 147 |
zapi: |
| 148 |
security-certificate-install: |
| 149 |
cert-name: "{{ ontap_cert_name }}" |
| 150 |
certificate: "{{ ssl_certificate }}" |
| 151 |
type: client-ca |
| 152 |
vserver: "{{ vserver }}" |
| 153 |
ignore_errors: true |
| 154 |
register: ontap |
| 155 |
- name: Print info |
| 156 |
ansible.builtin.debug: |
| 157 |
var: ontap |
| 158 |
tags: never,testpb |
| 159 |
- name: Fail module |
| 160 |
ansible.builtin.fail: |
| 161 |
msg: "Failed to install certificate: {{ ontap }}" |
| 162 |
tags: never,testpb |
| 163 |
when: ontap.failed and ontap.reason != "duplicate entry" |
| 164 |
|
| 165 |
- name: Use ZAPIT to enable certificate authentication |
| 166 |
netapp.ontap.na_ontap_zapit: |
| 167 |
<<: *login |
| 168 |
zapi: |
| 169 |
security-ssl-modify: |
| 170 |
client-authentication-enabled: true |
| 171 |
vserver: "{{ vserver }}" |
| 172 |
register: ontap |
| 173 |
- name: Print info |
| 174 |
ansible.builtin.debug: |
| 175 |
var: ontap |
| 176 |
tags: never,testpb |
| 177 |
|
| 178 |
- name: Set up cert authentication for ontapi (ZAPI) and http (REST) |
| 179 |
netapp.ontap.na_ontap_user: |
| 180 |
<<: *login |
| 181 |
applications: ontapi,http |
| 182 |
authentication_method: cert |
| 183 |
name: "{{ ontap_cert_user }}" |
| 184 |
role_name: "{{ ontap_cert_role }}" |
| 185 |
vserver: "{{ vserver }}" |
| 186 |
register: ontap |
| 187 |
- name: Print info |
| 188 |
ansible.builtin.debug: |
| 189 |
var: ontap |
| 190 |
tags: never,testpb |
| 191 |
|
| 192 |
- name: Validate cert authentication is working for ZAPI |
| 193 |
netapp.ontap.na_ontap_info: |
| 194 |
<<: *cert_login |
| 195 |
gather_subset: ontap_version |
| 196 |
register: ontap |
| 197 |
- name: Print info |
| 198 |
ansible.builtin.debug: |
| 199 |
var: ontap |
| 200 |
|
| 201 |
- name: Remove cert authentication for ontapi (ZAPI) and http (REST) when testing |
| 202 |
tags: never,testpb |
| 203 |
netapp.ontap.na_ontap_user: |
| 204 |
<<: *login |
| 205 |
state: absent |
| 206 |
applications: ontapi,http |
| 207 |
authentication_method: cert |
| 208 |
name: "{{ ontap_cert_user }}" |
| 209 |
role_name: "{{ ontap_cert_role }}" |
| 210 |
vserver: "{{ vserver }}" |
| 211 |
register: ontap |
| 212 |
- name: Print info |
| 213 |
ansible.builtin.debug: |
| 214 |
var: ontap |
| 215 |
tags: never,testpb |
| 216 |
|
| 217 |
- name: Use ZAPIT to delete certificate when testing |
| 218 |
# use -t all,never when testing the playbook |
| 219 |
tags: never,testpb,delete |
| 220 |
netapp.ontap.na_ontap_zapit: |
| 221 |
<<: *login |
| 222 |
zapi: |
| 223 |
security-certificate-delete: |
| 224 |
certificate-authority: "{{ certificate_authority }}" |
| 225 |
common-name: "{{ certificate_authority }}" |
| 226 |
serial-number: "{{ serial_number }}" |
| 227 |
type: client-ca |
| 228 |
vserver: "{{ vserver }}" |
| 229 |
when: certificate_installed |