collection 교체

collection/community/general/plugins/lookup/random_string.py

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
-# Copyright: (c) 2021, Abhijeet Kasurde <akasurde@redhat.com>
-# Copyright: (c) 2018, Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (c) 2021, Abhijeet Kasurde <akasurde@redhat.com>
+# Copyright (c) 2018, Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 from __future__ import absolute_import, division, print_function
 
@@ -15,6 +16,8 @@ DOCUMENTATION = r"""
     version_added: '3.2.0'
     description:
       - Generates random string based upon the given constraints.
+      - Uses L(random.SystemRandom,https://docs.python.org/3/library/random.html#random.SystemRandom),
+        so should be strong enough for cryptographic purposes.
     options:
       length:
         description: The length of the string.
@@ -41,25 +44,25 @@ DOCUMENTATION = r"""
         - Special characters are taken from Python standard library C(string).
           See L(the documentation of string.punctuation,https://docs.python.org/3/library/string.html#string.punctuation)
           for which characters will be used.
-        - The choice of special characters can be changed to setting I(override_special).
+        - The choice of special characters can be changed to setting O(override_special).
         default: true
         type: bool
       min_numeric:
         description:
         - Minimum number of numeric characters in the string.
-        - If set, overrides I(numbers=false).
+        - If set, overrides O(numbers=false).
         default: 0
         type: int
       min_upper:
         description:
         - Minimum number of uppercase alphabets in the string.
-        - If set, overrides I(upper=false).
+        - If set, overrides O(upper=false).
         default: 0
         type: int
       min_lower:
         description:
         - Minimum number of lowercase alphabets in the string.
-        - If set, overrides I(lower=false).
+        - If set, overrides O(lower=false).
         default: 0
         type: int
       min_special:
@@ -69,14 +72,27 @@ DOCUMENTATION = r"""
         type: int
       override_special:
         description:
-        - Overide a list of special characters to use in the string.
-        - If set I(min_special) should be set to a non-default value.
+        - Override a list of special characters to use in the string.
+        - If set O(min_special) should be set to a non-default value.
         type: str
       override_all:
         description:
-        - Override all values of I(numbers), I(upper), I(lower), and I(special) with
+        - Override all values of O(numbers), O(upper), O(lower), and O(special) with
           the given list of characters.
         type: str
+      ignore_similar_chars:
+        description:
+        - Ignore similar characters, such as V(l) and V(1), or V(O) and V(0).
+        - These characters can be configured in O(similar_chars).
+        default: false
+        type: bool
+        version_added: 7.5.0
+      similar_chars:
+        description:
+        - Override a list of characters not to be use in the string.
+        default: "il1LoO0"
+        type: str
+        version_added: 7.5.0
       base64:
         description:
         - Returns base64 encoded string.
@@ -100,7 +116,7 @@ EXAMPLES = r"""
     var: lookup('community.general.random_string', base64=True)
   # Example result: ['NHZ6eWN5Qk0=']
 
-- name: Generate a random string with 1 lower, 1 upper, 1 number and 1 special char (atleast)
+- name: Generate a random string with 1 lower, 1 upper, 1 number and 1 special char (at least)
   ansible.builtin.debug:
     var: lookup('community.general.random_string', min_lower=1, min_upper=1, min_special=1, min_numeric=1)
   # Example result: ['&Qw2|E[-']
@@ -170,9 +186,17 @@ class LookupModule(LookupBase):
         length = self.get_option("length")
         base64_flag = self.get_option("base64")
         override_all = self.get_option("override_all")
+        ignore_similar_chars = self.get_option("ignore_similar_chars")
+        similar_chars = self.get_option("similar_chars")
         values = ""
         available_chars_set = ""
 
+        if ignore_similar_chars:
+            number_chars = "".join([sc for sc in number_chars if sc not in similar_chars])
+            lower_chars = "".join([sc for sc in lower_chars if sc not in similar_chars])
+            upper_chars = "".join([sc for sc in upper_chars if sc not in similar_chars])
+            special_chars = "".join([sc for sc in special_chars if sc not in similar_chars])
+
         if override_all:
             # Override all the values
             available_chars_set = override_all