python4cpm 1.0.15__tar.gz → 1.0.17__tar.gz

{python4cpm-1.0.15/src/python4cpm.egg-info → python4cpm-1.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python4cpm
-Version: 1.0.15
+Version: 1.0.17
 Summary: Python for CPM
 Author-email: Gonzalo Atienza Rela <gonatienza@gmail.com>
 License: MIT License
@@ -45,7 +45,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 3. Install `python4cpm` in your venv:
     - If your CPM can connect to the internet, install with `c:\venv\Scripts\pip install python4cpm`.
     - If your CPM cannot connect to the internet:
-        - Download the [latest wheel](https://github.com/gonatienza/python4cpm/releases/download/latest/python4cpm-wheel.zip).
+        - Download the `python4cpm-wheel.zip` asset from the latest [release](https://github.com/gonatienza/python4cpm/releases).
         - Copy the file to CPM and extract to a temporary location.
         - From the temporary location run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 
@@ -53,7 +53,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 ### Importing the platform
 
 1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
-2. Download the [latest platform zip file](https://github.com/gonatienza/python4cpm/releases/download/latest/python4cpm-platform.zip).
+2. Download the `python4cpm-platform.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
 3. Import the platform zip file into Privilege Cloud/PVWA `(Administration -> Platform Management -> Import platform)`.
 4. Craft your python script and place it within the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
 5. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
@@ -72,7 +72,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 from python4cpm import Python4CPM
 
 
-p4cpm = Python4CPM("MyApp") # this instantiates the object and grabs all arguments and secrets shared by TPC
+p4cpm = Python4CPM("MyApp") # this instantiates the object and grabs all arguments and secrets shared by the .NET SDK
 
 # These are the usable properties and related methods from the object:
 p4cpm.args.action # action requested from CPM
@@ -197,12 +197,12 @@ Install this module (in a dev workstation) with:
 pip install python4cpm
 ```
 
-**Note**: As CPM runs in Windows, the plugin was built to pass secrets securely to the `Python4CPM.crypto` module using the Data Protection API (DPAPI).  For dev purposes in Linux/Mac dev workstations, those secrets will appear as plaintext in the process environment.  This is informational only, the module will use its encryption/decryption capabilities automatically in Windows and you do not have to do anything specific to enable it.
+**Note**: As CPM runs in Windows, the plugin was built to pass secrets securely to the `Python4CPM.crypto` module using the Data Protection API (DPAPI).  For dev purposes in Linux/Mac dev workstations, those secrets will appear as plaintext in the environment of the process.  This is informational only, the module will use its encryption/decryption capabilities automatically in Windows and you do not have to do anything specific to enable it.
 
 ### Example:
 
 ```python
-from python4cpm import TPCHelper, Python4CPM
+from python4cpm import NETHelper, Python4CPM
 from getpass import getpass
 
 # Get secrets for your password, logon account password, reconcile account password and new password
@@ -212,7 +212,7 @@ logon_password = getpass("logon_password: ") # password from linked logon accoun
 reconcile_password = getpass("reconcile_password: ") # password from linked reconcile account
 new_password = getpass("new_password: ") # new password for the rotation
 
-p4cpm = TPCHelper.run(
+p4cpm = NETHelper.run(
     action=Python4CPM.ACTION_LOGON, # use actions from Python4CPM.ACTION_*
     address="myapp.corp.local", # populate with the address from your account properties
     username="jdoe", # populate with the username from your account properties
@@ -232,12 +232,12 @@ p4cpm.log_info("success!")
 p4cpm.close_success()
 
 # Remember for your final script:
-## changing the definition of p4cpm from TPCHelper.run() to Python4CPM("MyApp")
+## changing the definition of p4cpm from NETHelper.run() to Python4CPM("MyApp")
 ## remove any secrets prompting
-## remove the TPCHelper import
+## remove the NETHelper import
 ```
 
 Remember for your final script:
-- Change the definition of `p4cpm` from `p4cpm = TPCHelper.run(**kwargs)` to `p4cpm = Python4CPM("MyApp")`.
+- Change the definition of `p4cpm` from `p4cpm = NETHelper.run(**kwargs)` to `p4cpm = Python4CPM("MyApp")`.
 - Remove any secrets prompting or interactive interruptions.
-- Remove the import of `TPCHelper`.
+- Remove the import of `NETHelper`.

{python4cpm-1.0.15 → python4cpm-1.0.17}/README.md

@@ -13,7 +13,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 3. Install `python4cpm` in your venv:
     - If your CPM can connect to the internet, install with `c:\venv\Scripts\pip install python4cpm`.
     - If your CPM cannot connect to the internet:
-        - Download the [latest wheel](https://github.com/gonatienza/python4cpm/releases/download/latest/python4cpm-wheel.zip).
+        - Download the `python4cpm-wheel.zip` asset from the latest [release](https://github.com/gonatienza/python4cpm/releases).
         - Copy the file to CPM and extract to a temporary location.
         - From the temporary location run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 
@@ -21,7 +21,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 ### Importing the platform
 
 1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
-2. Download the [latest platform zip file](https://github.com/gonatienza/python4cpm/releases/download/latest/python4cpm-platform.zip).
+2. Download the `python4cpm-platform.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
 3. Import the platform zip file into Privilege Cloud/PVWA `(Administration -> Platform Management -> Import platform)`.
 4. Craft your python script and place it within the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
 5. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
@@ -40,7 +40,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 from python4cpm import Python4CPM
 
 
-p4cpm = Python4CPM("MyApp") # this instantiates the object and grabs all arguments and secrets shared by TPC
+p4cpm = Python4CPM("MyApp") # this instantiates the object and grabs all arguments and secrets shared by the .NET SDK
 
 # These are the usable properties and related methods from the object:
 p4cpm.args.action # action requested from CPM
@@ -165,12 +165,12 @@ Install this module (in a dev workstation) with:
 pip install python4cpm
 ```
 
-**Note**: As CPM runs in Windows, the plugin was built to pass secrets securely to the `Python4CPM.crypto` module using the Data Protection API (DPAPI).  For dev purposes in Linux/Mac dev workstations, those secrets will appear as plaintext in the process environment.  This is informational only, the module will use its encryption/decryption capabilities automatically in Windows and you do not have to do anything specific to enable it.
+**Note**: As CPM runs in Windows, the plugin was built to pass secrets securely to the `Python4CPM.crypto` module using the Data Protection API (DPAPI).  For dev purposes in Linux/Mac dev workstations, those secrets will appear as plaintext in the environment of the process.  This is informational only, the module will use its encryption/decryption capabilities automatically in Windows and you do not have to do anything specific to enable it.
 
 ### Example:
 
 ```python
-from python4cpm import TPCHelper, Python4CPM
+from python4cpm import NETHelper, Python4CPM
 from getpass import getpass
 
 # Get secrets for your password, logon account password, reconcile account password and new password
@@ -180,7 +180,7 @@ logon_password = getpass("logon_password: ") # password from linked logon accoun
 reconcile_password = getpass("reconcile_password: ") # password from linked reconcile account
 new_password = getpass("new_password: ") # new password for the rotation
 
-p4cpm = TPCHelper.run(
+p4cpm = NETHelper.run(
     action=Python4CPM.ACTION_LOGON, # use actions from Python4CPM.ACTION_*
     address="myapp.corp.local", # populate with the address from your account properties
     username="jdoe", # populate with the username from your account properties
@@ -200,12 +200,12 @@ p4cpm.log_info("success!")
 p4cpm.close_success()
 
 # Remember for your final script:
-## changing the definition of p4cpm from TPCHelper.run() to Python4CPM("MyApp")
+## changing the definition of p4cpm from NETHelper.run() to Python4CPM("MyApp")
 ## remove any secrets prompting
-## remove the TPCHelper import
+## remove the NETHelper import
 ```
 
 Remember for your final script:
-- Change the definition of `p4cpm` from `p4cpm = TPCHelper.run(**kwargs)` to `p4cpm = Python4CPM("MyApp")`.
+- Change the definition of `p4cpm` from `p4cpm = NETHelper.run(**kwargs)` to `p4cpm = Python4CPM("MyApp")`.
 - Remove any secrets prompting or interactive interruptions.
-- Remove the import of `TPCHelper`.
+- Remove the import of `NETHelper`.

{python4cpm-1.0.15 → python4cpm-1.0.17}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python4cpm"
-version = "1.0.15"
+version = "1.0.17"
 description = "Python for CPM"
 authors = [
   { name = "Gonzalo Atienza Rela", email = "gonatienza@gmail.com" }

{python4cpm-1.0.15 → python4cpm-1.0.17}/src/python4cpm/__init__.py

@@ -1,6 +1,6 @@
 from python4cpm.python4cpm import Python4CPM
 from python4cpm.args import Args
-from python4cpm.secrets import SecureString, Secrets
+from python4cpm.secrets import Secret, Secrets
 from python4cpm.crypto import Crypto
 from python4cpm.nethelper import NETHelper
 from importlib.metadata import version as __version
@@ -9,7 +9,7 @@ __version__ = __version(__name__)
 
 __all__ = [
     Args,
-    SecureString,
+    Secret,
     Secrets,
     Python4CPM,
     Crypto,

{python4cpm-1.0.15 → python4cpm-1.0.17}/src/python4cpm/crypto.py

@@ -43,14 +43,14 @@ class Crypto:
         if crypt_res:
             plaintext = ctypes.string_at(output_blob.pbData, output_blob.cbData)
             ctypes.windll.kernel32.LocalFree(output_blob.pbData)
-            return plaintext.decode()
+            return plaintext.decode("utf-16-le")
         else:
             raise ctypes.WinError()
 
     @classmethod
     def encrypt(cls, plaintext: str) -> str:
         cls._verify_enabled()
-        plain_bytes = plaintext.encode()
+        plain_bytes = plaintext.encode("utf-16-le")
         buffer = ctypes.create_string_buffer(plain_bytes)
         input_blob = cls.DataBlob(
             len(plain_bytes),

{python4cpm-1.0.15 → python4cpm-1.0.17}/src/python4cpm/secrets.py

@@ -1,17 +1,12 @@
 from python4cpm.crypto import Crypto
 
 
-class SecureString:
+class Secret:
     def __init__(self, secret: str) -> None:
         self._secret = secret
-        self._is_encrypted = Crypto.ENABLED
-
-    @property
-    def is_encrypted(self):
-        return self._is_encrypted
 
     def get(self) -> str:
-        if self._is_encrypted and self._secret:
+        if Crypto.ENABLED and self._secret:
             return Crypto.decrypt(self._secret)
         else:
             return self._secret
@@ -32,10 +27,10 @@ class Secrets:
         reconcile_password: str,
         new_password: str
     ) -> None:
-        self._password = SecureString(password)
-        self._logon_password = SecureString(logon_password)
-        self._reconcile_password = SecureString(reconcile_password)
-        self._new_password = SecureString(new_password)
+        self._password = Secret(password)
+        self._logon_password = Secret(logon_password)
+        self._reconcile_password = Secret(reconcile_password)
+        self._new_password = Secret(new_password)
 
     @property
     def password(self) -> str:

{python4cpm-1.0.15 → python4cpm-1.0.17/src/python4cpm.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python4cpm
-Version: 1.0.15
+Version: 1.0.17
 Summary: Python for CPM
 Author-email: Gonzalo Atienza Rela <gonatienza@gmail.com>
 License: MIT License
@@ -45,7 +45,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 3. Install `python4cpm` in your venv:
     - If your CPM can connect to the internet, install with `c:\venv\Scripts\pip install python4cpm`.
     - If your CPM cannot connect to the internet:
-        - Download the [latest wheel](https://github.com/gonatienza/python4cpm/releases/download/latest/python4cpm-wheel.zip).
+        - Download the `python4cpm-wheel.zip` asset from the latest [release](https://github.com/gonatienza/python4cpm/releases).
         - Copy the file to CPM and extract to a temporary location.
         - From the temporary location run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 
@@ -53,7 +53,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 ### Importing the platform
 
 1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
-2. Download the [latest platform zip file](https://github.com/gonatienza/python4cpm/releases/download/latest/python4cpm-platform.zip).
+2. Download the `python4cpm-platform.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
 3. Import the platform zip file into Privilege Cloud/PVWA `(Administration -> Platform Management -> Import platform)`.
 4. Craft your python script and place it within the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
 5. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
@@ -72,7 +72,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 from python4cpm import Python4CPM
 
 
-p4cpm = Python4CPM("MyApp") # this instantiates the object and grabs all arguments and secrets shared by TPC
+p4cpm = Python4CPM("MyApp") # this instantiates the object and grabs all arguments and secrets shared by the .NET SDK
 
 # These are the usable properties and related methods from the object:
 p4cpm.args.action # action requested from CPM
@@ -197,12 +197,12 @@ Install this module (in a dev workstation) with:
 pip install python4cpm
 ```
 
-**Note**: As CPM runs in Windows, the plugin was built to pass secrets securely to the `Python4CPM.crypto` module using the Data Protection API (DPAPI).  For dev purposes in Linux/Mac dev workstations, those secrets will appear as plaintext in the process environment.  This is informational only, the module will use its encryption/decryption capabilities automatically in Windows and you do not have to do anything specific to enable it.
+**Note**: As CPM runs in Windows, the plugin was built to pass secrets securely to the `Python4CPM.crypto` module using the Data Protection API (DPAPI).  For dev purposes in Linux/Mac dev workstations, those secrets will appear as plaintext in the environment of the process.  This is informational only, the module will use its encryption/decryption capabilities automatically in Windows and you do not have to do anything specific to enable it.
 
 ### Example:
 
 ```python
-from python4cpm import TPCHelper, Python4CPM
+from python4cpm import NETHelper, Python4CPM
 from getpass import getpass
 
 # Get secrets for your password, logon account password, reconcile account password and new password
@@ -212,7 +212,7 @@ logon_password = getpass("logon_password: ") # password from linked logon accoun
 reconcile_password = getpass("reconcile_password: ") # password from linked reconcile account
 new_password = getpass("new_password: ") # new password for the rotation
 
-p4cpm = TPCHelper.run(
+p4cpm = NETHelper.run(
     action=Python4CPM.ACTION_LOGON, # use actions from Python4CPM.ACTION_*
     address="myapp.corp.local", # populate with the address from your account properties
     username="jdoe", # populate with the username from your account properties
@@ -232,12 +232,12 @@ p4cpm.log_info("success!")
 p4cpm.close_success()
 
 # Remember for your final script:
-## changing the definition of p4cpm from TPCHelper.run() to Python4CPM("MyApp")
+## changing the definition of p4cpm from NETHelper.run() to Python4CPM("MyApp")
 ## remove any secrets prompting
-## remove the TPCHelper import
+## remove the NETHelper import
 ```
 
 Remember for your final script:
-- Change the definition of `p4cpm` from `p4cpm = TPCHelper.run(**kwargs)` to `p4cpm = Python4CPM("MyApp")`.
+- Change the definition of `p4cpm` from `p4cpm = NETHelper.run(**kwargs)` to `p4cpm = Python4CPM("MyApp")`.
 - Remove any secrets prompting or interactive interruptions.
-- Remove the import of `TPCHelper`.
+- Remove the import of `NETHelper`.