search

linux-system-roles / nbde_client

Ansible role for configuring Network Bound Disk Encryption clients (e.g. clevis)
https://linux-system-roles.github.io/nbde_client/
MIT License
14 stars 24 forks source link

Add check for non-inclusive language #91

Closed nhosoi closed 1 year ago

nhosoi commented 1 year ago

Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml

Clean up non-inclusive words.

Note: master is left in nbde_client_clevis.py as follows, which causes the non-inclusive language check action fails.

library/nbde_client_clevis.py:    """Generate a new key with the same entropy as the LUKS master key.

There are three ways to fix it - 1) replacing LUKS master key with a phrase that does not include master or 2) leaving LUKS master key as it is and applying https://github.com/get-woke/woke/pull/252 that allows the warning level severity or 3) ignoring "the LUKS master key" by wokeignore:rule=master.

I've updated the pr using (3) as seen at https://github.com/linux-system-roles/nbde_client/pull/91/files#diff-fcb01b85ce6e35eb2f419f284a8ac712d435336b141a96ec73a2a03edade7f5aR1003, which makes the woke test pass. Is it ok?

richm commented 1 year ago

lgtm - @sergio-correia ?

sergio-correia commented 1 year ago

LGTM as well. Apologies for the delay, I missed this one.