Skip to content

Commit b2f78b8

Browse files
widhalmtdanopt
widhalmt
and
danopt
authored
Make cert expiration check independent of locale (#125)
This will use another module for checking expiration dates of certificates fixes #124 --------- Co-authored-by: Daniel Patrick <[email protected]>
1 parent eb430a5 commit b2f78b8

File tree

18 files changed

+952
-18
lines changed

18 files changed

+952
-18
lines changed

‎.config/pep8.cfg

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[pep8]
2+
ignore = E402, E123
3+
# It's fine to have line-length of 99
4+
max-line-length = 99

‎.github/workflows/test_full_stack.yml

+1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ jobs:
5050
- debian10
5151
scenario:
5252
- elasticstack_default
53+
- plugins
5354
release:
5455
- 7
5556
- 8

‎.github/workflows/test_plugins.yml

+223
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
---
2+
name: Test Plugins
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
logLevel:
7+
description: 'Log level'
8+
required: true
9+
default: 'warning'
10+
type: choice
11+
options:
12+
- info
13+
- warning
14+
- debug
15+
push:
16+
branches:
17+
- 'feature/**'
18+
- 'fix/**'
19+
- '!doc/**'
20+
paths:
21+
- 'plugins/**'
22+
- '.github/workflows/test_plugins.yml'
23+
- 'molecule/plugins/**'
24+
- '.config/pep8.yml'
25+
- 'tests/**'
26+
pull_request:
27+
branches:
28+
- 'feature/**'
29+
- 'fix/**'
30+
- '!doc/**'
31+
paths:
32+
- 'plugins/**'
33+
- '.github/workflows/test_plugins.yml'
34+
- 'molecule/plugins/**'
35+
- '.config/pep8.yml'
36+
- 'tests/**'
37+
38+
jobs:
39+
pep8:
40+
runs-on: ubuntu-latest
41+
steps:
42+
- name: Check out the codebase.
43+
uses: actions/checkout@v3
44+
45+
- name: Set up Python 3.
46+
uses: actions/setup-python@v4
47+
with:
48+
python-version: '3.x'
49+
50+
- name: Install test dependencies.
51+
run: |
52+
python3 -m pip install --upgrade pip
53+
python3 -m pip install pep8
54+
55+
- name: Lint code.
56+
run: |
57+
pep8 plugins/ --config=.config/pep8.cfg --statistics --count
58+
59+
unit-test:
60+
needs: pep8
61+
runs-on: ubuntu-20.04
62+
63+
env:
64+
COLLECTION_NAMESPACE: netways
65+
COLLECTION_NAME: elasticstack
66+
67+
strategy:
68+
fail-fast: false
69+
max-parallel: 1
70+
71+
steps:
72+
- name: Check out code
73+
uses: actions/checkout@v3
74+
75+
- name: Set up Python 3.9.14
76+
uses: actions/setup-python@v3
77+
with:
78+
python-version: 3.9.14
79+
80+
- name: Install dependencies
81+
run: |
82+
python -m pip install --upgrade pip
83+
python -m pip install install ansible
84+
85+
- name: Install collection
86+
run: |
87+
mkdir -p ~/.ansible/collections/ansible_collections/$COLLECTION_NAMESPACE
88+
cp -a ../ansible-collection-$COLLECTION_NAME ~/.ansible/collections/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
89+
90+
- name: Test `cert_info` module
91+
run: |
92+
python tests/unit/plugins/modules/test_cert_info.py
93+
env:
94+
PY_COLORS: '1'
95+
ANSIBLE_FORCE_COLOR: '1'
96+
97+
- name: Test `certs` module util
98+
run: |
99+
python tests/unit/plugins/module_utils/test_certs.py
100+
env:
101+
PY_COLORS: '1'
102+
ANSIBLE_FORCE_COLOR: '1'
103+
104+
python:
105+
needs: unit-test
106+
runs-on: ubuntu-20.04
107+
108+
env:
109+
COLLECTION_NAMESPACE: netways
110+
COLLECTION_NAME: elasticstack
111+
112+
strategy:
113+
fail-fast: false
114+
max-parallel: 1
115+
matrix:
116+
python_version: [ 2.7.18, 3.5.10, 3.6.15, 3.7.13, 3.8.16, 3.10.10 ]
117+
118+
steps:
119+
- name: Check out code
120+
uses: actions/checkout@v3
121+
122+
- name: Set up Python ${{ matrix.python_version }}
123+
uses: actions/setup-python@v3
124+
with:
125+
python-version: ${{ matrix.python_version }}
126+
127+
- name: Install dependencies
128+
run: |
129+
python -m pip install --upgrade pip
130+
python -m pip install install ansible
131+
132+
- name: Install collection
133+
run: |
134+
mkdir -p ~/.ansible/collections/ansible_collections/$COLLECTION_NAMESPACE
135+
cp -a ../ansible-collection-$COLLECTION_NAME ~/.ansible/collections/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
136+
137+
- name: Test with ansible-playbook
138+
run: |
139+
ansible-playbook molecule/plugins/converge.yml
140+
env:
141+
PY_COLORS: '1'
142+
ANSIBLE_FORCE_COLOR: '1'
143+
144+
ansible-core:
145+
needs: python
146+
runs-on: ubuntu-20.04
147+
148+
env:
149+
COLLECTION_NAMESPACE: netways
150+
COLLECTION_NAME: elasticstack
151+
152+
strategy:
153+
fail-fast: false
154+
max-parallel: 1
155+
matrix:
156+
ansible_core_version: [ 2.11.12, 2.12.10, 2.13.8, 2.14.4 ]
157+
158+
steps:
159+
- name: Check out code
160+
uses: actions/checkout@v3
161+
162+
- name: Set up Python 3.9.14
163+
uses: actions/setup-python@v3
164+
with:
165+
python-version: 3.9.14
166+
167+
- name: Install dependencies
168+
run: |
169+
python -m pip install --upgrade pip
170+
python -m pip install install ansible-core==${{ matrix.ansible_core_version }}
171+
172+
- name: Install collection
173+
run: |
174+
mkdir -p ~/.ansible/collections/ansible_collections/$COLLECTION_NAMESPACE
175+
cp -a ../ansible-collection-$COLLECTION_NAME ~/.ansible/collections/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
176+
177+
- name: Test with ansible-playbook
178+
run: |
179+
ansible-playbook molecule/plugins/converge.yml
180+
env:
181+
PY_COLORS: '1'
182+
ANSIBLE_FORCE_COLOR: '1'
183+
184+
python-cryptography:
185+
needs: ansible-core
186+
runs-on: ubuntu-20.04
187+
188+
env:
189+
COLLECTION_NAMESPACE: netways
190+
COLLECTION_NAME: elasticstack
191+
192+
strategy:
193+
fail-fast: false
194+
max-parallel: 1
195+
matrix:
196+
python_cryptography_version: [ 2.5, 3.0, 3.1, 3.2, 3.3, 3.4, 35.0.0, 36.0.0, 38.0.0, 40.0.1]
197+
198+
steps:
199+
- name: Check out code
200+
uses: actions/checkout@v3
201+
202+
- name: Set up Python 3.9.14
203+
uses: actions/setup-python@v3
204+
with:
205+
python-version: 3.9.14
206+
207+
- name: Install dependencies
208+
run: |
209+
python -m pip install --upgrade pip
210+
python -m pip install install cryptography==${{ matrix.python_cryptography_version }}
211+
python -m pip install install ansible
212+
213+
- name: Install collection
214+
run: |
215+
mkdir -p ~/.ansible/collections/ansible_collections/$COLLECTION_NAMESPACE
216+
cp -a ../ansible-collection-$COLLECTION_NAME ~/.ansible/collections/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
217+
218+
- name: Test with ansible-playbook
219+
run: |
220+
ansible-playbook molecule/plugins/converge.yml
221+
env:
222+
PY_COLORS: '1'
223+
ANSIBLE_FORCE_COLOR: '1'

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.cache
22
*.swp
3+
__pycache__*

‎molecule/plugins/converge.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
# The workaround for arbitrarily named role directory is important because the git repo has one name and the role within it another
3+
# Found at: https://github.com/ansible-community/molecule/issues/1567#issuecomment-436876722
4+
- name: Converge
5+
collections:
6+
- netways.elasticstack
7+
hosts: localhost
8+
tasks:
9+
#
10+
# Test modules
11+
#
12+
- name: Test
13+
cert_info:
14+
path: files/es-ca/elastic-stack-ca.p12
15+
passphrase: PleaseChangeMe
16+
register: test
17+
- name: Debug
18+
debug:
19+
msg: "{{ test }}"
20+
- name: Test required parameters (missing path)
21+
cert_info:
22+
passphrase: PleaseChangeMe
23+
ignore_errors: true
24+
- name: Test wrong path
25+
cert_info:
26+
path: es-ca-wrong
27+
passphrase: PleaseChangeMe
28+
ignore_errors: true
29+
- name: Debug with to_datetime() - (( test.not_valid_after | to_datetime()) - (ansible_date_time.date | to_datetime('%Y-%m-%d'))).days
30+
debug:
31+
msg: >-
32+
"{{ (( test.not_valid_after | to_datetime()) - (ansible_date_time.date | to_datetime('%Y-%m-%d'))).days }}"
33+
- name: Test wrong passphrase
34+
cert_info:
35+
path: files/es-ca/elastic-stack-ca.p12
36+
passphrase: PleaseChangeMe-wrong
37+
ignore_errors: true
38+
- name: Test no passphrase
39+
cert_info:
40+
path: files/es-ca/elastic-stack-ca.p12
41+
ignore_errors: true
42+
- name: Test no parameters
43+
cert_info:
44+
ignore_errors: true

‎molecule/plugins/files/es-ca/ca.crt

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Bag Attributes
2+
friendlyName: ca
3+
2.16.840.1.113894.746875.1.1: <Unsupported tag 6>
4+
subject=CN = Elastic Certificate Tool Autogenerated CA
5+
issuer=CN = Elastic Certificate Tool Autogenerated CA
6+
-----BEGIN CERTIFICATE-----
7+
MIIDSTCCAjGgAwIBAgIUfhOfRtiBlwFsDhK9aaQoF9Vzk6gwDQYJKoZIhvcNAQEL
8+
BQAwNDEyMDAGA1UEAxMpRWxhc3RpYyBDZXJ0aWZpY2F0ZSBUb29sIEF1dG9nZW5l
9+
cmF0ZWQgQ0EwHhcNMjMwMzI5MDE1ODAyWhcNMjYwMzI4MDE1ODAyWjA0MTIwMAYD
10+
VQQDEylFbGFzdGljIENlcnRpZmljYXRlIFRvb2wgQXV0b2dlbmVyYXRlZCBDQTCC
11+
ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANr2qXV6Lxm26yeqkCWVu9E6
12+
sGqms3nxH6ThVT20u4dcwi0doibKdBzideN37XRE+txv6bAhzoAIe8+ahOx/DQu1
13+
OPXIESPW+8FZcWtrFQs/uhrjBKLj09bKI46JODbsfse70454t63fwUn1D1kw9l//
14+
UrxAS7MSceeGfrcJ+XZjMWuTuqqKhal6dA4wji3BJ/LY8rAD2G1o7uk5xHaGyLUy
15+
h6ilJX0UbwVGAPCHZR0pQSFp5rQVUvm2QuvfOtwidPytX/9WmSB1A9nqEeKNJAMe
16+
92VDFgOcUstuKwqs7ZgfdKLscgNuQSCGHR7mwBi3L6RDpgw6JJ+lBA2TPi1/a/kC
17+
AwEAAaNTMFEwHQYDVR0OBBYEFIJTIBHHc6deKnfB3yLkI7TEULrPMB8GA1UdIwQY
18+
MBaAFIJTIBHHc6deKnfB3yLkI7TEULrPMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZI
19+
hvcNAQELBQADggEBAGavr5FxsXeQZVt0I51wZgS2M+fUNFhprFYxFo9ZDK1fa3IT
20+
xQ5CRzbHYjajXqBlNxlxker0eCXdYGVI6o909H4t1ZagDGYjPjXXzL6JHnoWL2b5
21+
dDlinlaQWmemd7esBy93lLamNpEsCx4X9b0TtewpNNxDf21y1FGT/68rJUXENjNV
22+
GSM8hMxveRHolvGtvXbW3r38VCpl/VwE2fCUSTX+VTbSFGfsVpQE9ZZnNa/FFIPs
23+
nu18bOAk3fRW1HL7E0ZoUfLIxANrqBxDkJZh0qzcOUoTpk/jT6mb07Btvi25g1DJ
24+
pC1XUcSmHwoeeaQ3HNNNFlyW4rQoi9j+LJnMvcY=
25+
-----END CERTIFICATE-----

‎molecule/plugins/files/es-ca/elastic-stack-ca.p12

2.61 KB
Binary file not shown.

‎molecule/plugins/files/es-ca/elasticsearch-cluster1.p12

3.62 KB
Binary file not shown.

‎molecule/plugins/files/es-ca/elasticsearch-cluster2.p12

3.62 KB
Binary file not shown.

‎plugins/module_utils/README.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Documentation: netways.elasticstack module_utils
2+
3+
## Overview
4+
- [`certs` module_util](#cert_info-module)
5+
6+
## `netways.elasticstack.certs` function
7+
8+
### `bytes_to_hex()` function
9+
10+
Since binascii.hexlify doesn't support a second parameter, which would define a seperator (e.g. ":") for hex strings in older Python versions like 2.6 and 2.7, we implemeted a small function to get similar results.
11+
12+
**Parameter:** A __bytes__ object that represent a hexadecimal value (e.g. b'\\x82S \\x11\\xc7s\\xa7^*w\\xc1\\xdf\"\\xe4#\\xb4\\xc4P\\xba\\xcf')
13+
14+
**Return:** A hexadecimal __string__ seperated by colons (e.g. "82:53:20:11:C7:73:A7:5E:2A:77:C1:DF:22:E4:23:B4:C4:50:BA:CF")
15+
16+
### `check_supported_extensions()` function
17+
18+
A function to check if the extension is supported. Returns true if extension name is found in `SUPPORTED_EXTENSIONS` dict.
19+
20+
**Parameter:** The extension name as __string__.
21+
22+
**Return:** Returns a __bool__.
23+
24+
### `check_supported_keys` function
25+
26+
A function to check if the extensions key is supported. Returns true if extensions key is found in `SUPPORTED_EXTENSIONS` dict.
27+
28+
**Parameter:** The key name as __string__.
29+
30+
**Return:** Returns a __bool__.
31+
32+
### `AnalyzeCertificate()` object
33+
34+
An object to load the certificate and to gather information about it.
35+
36+
**Parameter:** The path (required) to the certificate and the passphrase (optional), both as __string__.
37+
38+
**Return:** Returns the result dict to the Ansible module.

0 commit comments

Comments
 (0)