python4cpm 1.0.22__tar.gz → 1.0.23__tar.gz

{python4cpm-1.0.22/src/python4cpm.egg-info → python4cpm-1.0.23}/PKG-INFO

@@ -1,30 +1,9 @@
 Metadata-Version: 2.4
 Name: python4cpm
-Version: 1.0.22
+Version: 1.0.23
 Summary: Python for CPM
 Author-email: Gonzalo Atienza Rela <gonatienza@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2026 Gonzalo Atienza Rela
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in
-        all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-        THE SOFTWARE.
-        
+License-Expression: MIT
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -32,7 +11,7 @@ Dynamic: license-file
 
 # Python4CPM
 
-A simple way of using python scripts with CyberArk CPM rotations.  This module leverages the [Credential Management .NET SDK](https://docs.cyberark.com/privilege-cloud-standard/latest/en/content/pasimp/plug-in-netinvoker.htm) from CyberArk to securely offload a password rotation logic into a python script.
+A simple way of using python scripts with CyberArk CPM/SRS rotations.  This module leverages the [Credential Management .NET SDK](https://docs.cyberark.com/privilege-cloud-standard/latest/en/content/pasimp/plug-in-netinvoker.htm) from CyberArk to securely offload a password rotation logic into a python script.
 
 This platform allows you to duplicate it multiple times, simply changing its settings from Privilege Cloud/PVWA to point to different python scripts leveraging the module `python4cpm`.
 
@@ -40,14 +19,14 @@ This platform allows you to duplicate it multiple times, simply changing its set
 
 ### Preparing Python
 
-1. Install Python in CPM.
+1. Install Python along CPM or the SRS Connector Management Agent.
     - **Python must be installed for all users**.  Follow the custom install steps from the installation wizard to check the checkbox.
-3. Create a venv in CPM, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
+3. Create a venv in the server, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
 4. 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 `python4cpm-*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
-        - Copy the file to CPM and extract to a temporary directory called `python4cpm-wheel`.
+        - Copy the file to the server into a temporary directory called `python4cpm-wheel`.
         - From the parent directory of `python4cpm-wheel` run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 
 
@@ -84,7 +63,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 from python4cpm import Python4CPMHandler
 
 
-class MyApp(Python4CPMHandler): # create a subclass for the Handler
+class MyRotator(Python4CPMHandler): # create a subclass for the Handler
     """
     These are the usable properties and methods from Python4CPMHandler:
     
@@ -101,13 +80,13 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
 
     Logging methods -> Will only log if PythonLogging (platform parameters) is set to yes (default is yes)
     
-        self.log_error("this is an error message") # logs error into Logs/ThirdParty/MyApp.log
-        self.log_warning("this is a warning message") # logs warning into Logs/ThirdParty/MyApp.log
-        self.log_info("this is an info message") # logs info into Logs/ThirdParty/MyApp.log
+        self.log_error("this is an error message") # logs error into Logs/ThirdParty/MyRotator.log
+        self.log_warning("this is a warning message") # logs warning into Logs/ThirdParty/MyRotator.log
+        self.log_info("this is an info message") # logs info into Logs/ThirdParty/MyRotator.log
     
     Logging level -> Will only log debug messages if PythonLoggingLevel (platform parameters) is set to debug (default is info)
     
-        self.log_debug("this is an debug message") # logs info into Logs/ThirdParty/MyApp.log if logging level is set to debug
+        self.log_debug("this is an debug message") # logs info into Logs/ThirdParty/MyRotator.log if logging level is set to debug
 
     =============================
     REQUIRED TERMINATION SIGNALS
@@ -160,9 +139,9 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
             # for your logic in a verification
         result = True
         if result is True:
-            self.log_info("verification successful") # logs info message into Logs/ThirdParty/MyApp.log
+            self.log_info("verification successful") # logs info message into Logs/ThirdParty/MyRotator.log
         else:
-            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyApp.log
+            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyRotator.log
             self.close_fail()
 
     def _change(self, from_reconcile=False):
@@ -176,26 +155,26 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
             # self.secrets.reconcile_password.get() and self.secrets.new_password.get() for your logic in a reconciliation
         result = True
         if result is True:
-            self.log_info("rotation successful") # logs info message into Logs/ThirdParty/MyApp.log
+            self.log_info("rotation successful") # logs info message into Logs/ThirdParty/MyRotator.log
         else:
-            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyApp.log
+            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyRotator.log
             self.close_fail()
 
 
 if __name__ == "__main__":
-    MyApp().run() # initializes the class and calls the action that was requested from CPM/SRS.
+    MyRotator().run() # initializes the class and calls the action that was requested from CPM/SRS.
 ```
 (*) More realistic examples can be found [here](https://github.com/gonatienza/python4cpm/blob/main/examples/python4cpmhandler).
 
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
-1. Verify -> the sciprt will be executed once with the `MyApp.verify()` method.
-2. Change -> the sciprt will be executed twice, once with the action `MyApp.logon()` method and once as `MyApp.change()` method.
-    - If all actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
-3. Reconcile -> the sciprt will be executed twice, once with the action `MyApp.prereconcile()` method and once as `MyApp.reconcile()` method.
-    - If all actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
-4. When calling `MyApp.logon()` or `MyApp.prereconcile()`: `self.secrets.new_password.get()` will always return an empty string.
-5. If a logon account is not linked, `self.args.logon_username` and `self.secrets.logon_password.get()` will return an empty string.
-6. If a reconcile account is not linked, `self.args.reconcile_username` and `self.secrets.reconcile_password.get()` will return an empty string.
+1. Verify -> the sciprt will be executed once running the `MyRotator.verify()` method.
+2. Change -> the sciprt will be executed twice, running first the `MyRotator.logon()` method and secondly the `MyRotator.change()` method.
+    - If both actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
+3. Reconcile -> the sciprt will be executed twice, running first the `MyRotator.prereconcile()` method and secondly the `MyRotator.reconcile()` method.
+    - If both actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
+4. When calling `MyRotator.verify()`, `MyRotator.logon()` or `MyRotator.prereconcile()`: `self.secrets.new_password.get()` will always return an empty string.
+5. If a logon account is not linked, `self.args.logon_username` and `self.secrets.logon_password.get()` will return empty strings.
+6. If a reconcile account is not linked, `self.args.reconcile_username` and `self.secrets.reconcile_password.get()` will return empty strings.
 
 
 ### Using Python4CPM properties and methods directly (for low level controls):
@@ -299,12 +278,12 @@ if __name__ == "__main__":
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
 1. Verify -> the sciprt will be executed once with the `p4cpm.args.action` as `Python4CPM.ACTION_VERIFY`.
 2. Change -> the sciprt will be executed twice, once with the action `p4cpm.args.action` as `Python4CPM.ACTION_LOGON` and once as `Python4CPM.ACTION_CHANGE`.
-    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
+    - If both actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
 3. Reconcile -> the sciprt will be executed twice, once with the `p4cpm.args.action` as `Python4CPM.ACTION_PRERECONCILE` and once as `Python4CPM.ACTION_RECONCILE`.
-    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
+    - If both actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
 4. When `p4cpm.args.action` comes as `Python4CPM.ACTION_VERIFY`, `Python4CPM.ACTION_LOGON` or `Python4CPM.ACTION_PRERECONCILE`: `p4cpm.secrets.new_password.get()` will always return an empty string.
-5. If a logon account is not linked, `p4cpm.args.logon_username` and `p4cpm.secrets.logon_password.get()` will return an empty string.
-6. If a reconcile account is not linked, `p4cpm.args.reconcile_username` and `p4cpm.secrets.reconcile_password.get()` will return an empty string.
+5. If a logon account is not linked, `p4cpm.args.logon_username` and `p4cpm.secrets.logon_password.get()` will return empty strings.
+6. If a reconcile account is not linked, `p4cpm.args.reconcile_username` and `p4cpm.secrets.reconcile_password.get()` will return empty strings.
 
 
 ### Installing dependencies in python venv
@@ -329,6 +308,8 @@ pip install python4cpm
 
 ### Example:
 
+#### Set your arguments and secrets:
+
 ```python
 from python4cpm import NETHelper, Python4CPM, Python4CPMHandler
 from getpass import getpass
@@ -339,11 +320,7 @@ password = getpass("password: ") # password from account
 logon_password = getpass("logon_password: ") # password from linked logon account
 reconcile_password = getpass("reconcile_password: ") # password from linked reconcile account
 new_password = getpass("new_password: ") # new password for the rotation
-```
-
-#### Set your arguments and secrets:
 
-```python
 NETHelper.set(
     action=Python4CPM.ACTION_LOGON, # use actions from Python4CPM.ACTION_*
     address="myapp.corp.local", # populate with the address from your account properties
@@ -362,7 +339,7 @@ NETHelper.set(
 #### Using the handler (recommended):
 
 ```python
-class MyApp(Python4CPMHandler):
+class MyRotator(Python4CPMHandler):
     def verify(self):
         # TODO: Add your logic here
         self.close_success()
@@ -383,7 +360,7 @@ class MyApp(Python4CPMHandler):
         # TODO: Add your logic here
         self.close_success()
 
-MyApp().run()
+MyRotator().run()
 ```
 
 #### Using Python4CPM properties and methods directly:
@@ -399,6 +376,7 @@ p4cpm.close_success()
 
 #### Remember for your final script:
 
-- Change the definition of `p4cpm` from `p4cpm = NETHelper.get()` to `p4cpm = Python4CPM("MyApp")` if you are using the properties and methods directly.
-- Remove any secrets prompting or interactive interruptions.
 - Remove the import of `NETHelper`.
+- Remove the `NETHelper.set()` call.
+- If applicable, change the definition of `p4cpm` from `p4cpm = NETHelper.get()` to `p4cpm = Python4CPM("MyApp")`.
+- Remove any secrets prompting or interactive interruptions.

{python4cpm-1.0.22 → python4cpm-1.0.23}/README.md

@@ -1,6 +1,6 @@
 # Python4CPM
 
-A simple way of using python scripts with CyberArk CPM rotations.  This module leverages the [Credential Management .NET SDK](https://docs.cyberark.com/privilege-cloud-standard/latest/en/content/pasimp/plug-in-netinvoker.htm) from CyberArk to securely offload a password rotation logic into a python script.
+A simple way of using python scripts with CyberArk CPM/SRS rotations.  This module leverages the [Credential Management .NET SDK](https://docs.cyberark.com/privilege-cloud-standard/latest/en/content/pasimp/plug-in-netinvoker.htm) from CyberArk to securely offload a password rotation logic into a python script.
 
 This platform allows you to duplicate it multiple times, simply changing its settings from Privilege Cloud/PVWA to point to different python scripts leveraging the module `python4cpm`.
 
@@ -8,14 +8,14 @@ This platform allows you to duplicate it multiple times, simply changing its set
 
 ### Preparing Python
 
-1. Install Python in CPM.
+1. Install Python along CPM or the SRS Connector Management Agent.
     - **Python must be installed for all users**.  Follow the custom install steps from the installation wizard to check the checkbox.
-3. Create a venv in CPM, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
+3. Create a venv in the server, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
 4. 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 `python4cpm-*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
-        - Copy the file to CPM and extract to a temporary directory called `python4cpm-wheel`.
+        - Copy the file to the server into a temporary directory called `python4cpm-wheel`.
         - From the parent directory of `python4cpm-wheel` run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 
 
@@ -52,7 +52,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 from python4cpm import Python4CPMHandler
 
 
-class MyApp(Python4CPMHandler): # create a subclass for the Handler
+class MyRotator(Python4CPMHandler): # create a subclass for the Handler
     """
     These are the usable properties and methods from Python4CPMHandler:
     
@@ -69,13 +69,13 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
 
     Logging methods -> Will only log if PythonLogging (platform parameters) is set to yes (default is yes)
     
-        self.log_error("this is an error message") # logs error into Logs/ThirdParty/MyApp.log
-        self.log_warning("this is a warning message") # logs warning into Logs/ThirdParty/MyApp.log
-        self.log_info("this is an info message") # logs info into Logs/ThirdParty/MyApp.log
+        self.log_error("this is an error message") # logs error into Logs/ThirdParty/MyRotator.log
+        self.log_warning("this is a warning message") # logs warning into Logs/ThirdParty/MyRotator.log
+        self.log_info("this is an info message") # logs info into Logs/ThirdParty/MyRotator.log
     
     Logging level -> Will only log debug messages if PythonLoggingLevel (platform parameters) is set to debug (default is info)
     
-        self.log_debug("this is an debug message") # logs info into Logs/ThirdParty/MyApp.log if logging level is set to debug
+        self.log_debug("this is an debug message") # logs info into Logs/ThirdParty/MyRotator.log if logging level is set to debug
 
     =============================
     REQUIRED TERMINATION SIGNALS
@@ -128,9 +128,9 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
             # for your logic in a verification
         result = True
         if result is True:
-            self.log_info("verification successful") # logs info message into Logs/ThirdParty/MyApp.log
+            self.log_info("verification successful") # logs info message into Logs/ThirdParty/MyRotator.log
         else:
-            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyApp.log
+            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyRotator.log
             self.close_fail()
 
     def _change(self, from_reconcile=False):
@@ -144,26 +144,26 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
             # self.secrets.reconcile_password.get() and self.secrets.new_password.get() for your logic in a reconciliation
         result = True
         if result is True:
-            self.log_info("rotation successful") # logs info message into Logs/ThirdParty/MyApp.log
+            self.log_info("rotation successful") # logs info message into Logs/ThirdParty/MyRotator.log
         else:
-            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyApp.log
+            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyRotator.log
             self.close_fail()
 
 
 if __name__ == "__main__":
-    MyApp().run() # initializes the class and calls the action that was requested from CPM/SRS.
+    MyRotator().run() # initializes the class and calls the action that was requested from CPM/SRS.
 ```
 (*) More realistic examples can be found [here](https://github.com/gonatienza/python4cpm/blob/main/examples/python4cpmhandler).
 
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
-1. Verify -> the sciprt will be executed once with the `MyApp.verify()` method.
-2. Change -> the sciprt will be executed twice, once with the action `MyApp.logon()` method and once as `MyApp.change()` method.
-    - If all actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
-3. Reconcile -> the sciprt will be executed twice, once with the action `MyApp.prereconcile()` method and once as `MyApp.reconcile()` method.
-    - If all actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
-4. When calling `MyApp.logon()` or `MyApp.prereconcile()`: `self.secrets.new_password.get()` will always return an empty string.
-5. If a logon account is not linked, `self.args.logon_username` and `self.secrets.logon_password.get()` will return an empty string.
-6. If a reconcile account is not linked, `self.args.reconcile_username` and `self.secrets.reconcile_password.get()` will return an empty string.
+1. Verify -> the sciprt will be executed once running the `MyRotator.verify()` method.
+2. Change -> the sciprt will be executed twice, running first the `MyRotator.logon()` method and secondly the `MyRotator.change()` method.
+    - If both actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
+3. Reconcile -> the sciprt will be executed twice, running first the `MyRotator.prereconcile()` method and secondly the `MyRotator.reconcile()` method.
+    - If both actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
+4. When calling `MyRotator.verify()`, `MyRotator.logon()` or `MyRotator.prereconcile()`: `self.secrets.new_password.get()` will always return an empty string.
+5. If a logon account is not linked, `self.args.logon_username` and `self.secrets.logon_password.get()` will return empty strings.
+6. If a reconcile account is not linked, `self.args.reconcile_username` and `self.secrets.reconcile_password.get()` will return empty strings.
 
 
 ### Using Python4CPM properties and methods directly (for low level controls):
@@ -267,12 +267,12 @@ if __name__ == "__main__":
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
 1. Verify -> the sciprt will be executed once with the `p4cpm.args.action` as `Python4CPM.ACTION_VERIFY`.
 2. Change -> the sciprt will be executed twice, once with the action `p4cpm.args.action` as `Python4CPM.ACTION_LOGON` and once as `Python4CPM.ACTION_CHANGE`.
-    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
+    - If both actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
 3. Reconcile -> the sciprt will be executed twice, once with the `p4cpm.args.action` as `Python4CPM.ACTION_PRERECONCILE` and once as `Python4CPM.ACTION_RECONCILE`.
-    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
+    - If both actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
 4. When `p4cpm.args.action` comes as `Python4CPM.ACTION_VERIFY`, `Python4CPM.ACTION_LOGON` or `Python4CPM.ACTION_PRERECONCILE`: `p4cpm.secrets.new_password.get()` will always return an empty string.
-5. If a logon account is not linked, `p4cpm.args.logon_username` and `p4cpm.secrets.logon_password.get()` will return an empty string.
-6. If a reconcile account is not linked, `p4cpm.args.reconcile_username` and `p4cpm.secrets.reconcile_password.get()` will return an empty string.
+5. If a logon account is not linked, `p4cpm.args.logon_username` and `p4cpm.secrets.logon_password.get()` will return empty strings.
+6. If a reconcile account is not linked, `p4cpm.args.reconcile_username` and `p4cpm.secrets.reconcile_password.get()` will return empty strings.
 
 
 ### Installing dependencies in python venv
@@ -297,6 +297,8 @@ pip install python4cpm
 
 ### Example:
 
+#### Set your arguments and secrets:
+
 ```python
 from python4cpm import NETHelper, Python4CPM, Python4CPMHandler
 from getpass import getpass
@@ -307,11 +309,7 @@ password = getpass("password: ") # password from account
 logon_password = getpass("logon_password: ") # password from linked logon account
 reconcile_password = getpass("reconcile_password: ") # password from linked reconcile account
 new_password = getpass("new_password: ") # new password for the rotation
-```
-
-#### Set your arguments and secrets:
 
-```python
 NETHelper.set(
     action=Python4CPM.ACTION_LOGON, # use actions from Python4CPM.ACTION_*
     address="myapp.corp.local", # populate with the address from your account properties
@@ -330,7 +328,7 @@ NETHelper.set(
 #### Using the handler (recommended):
 
 ```python
-class MyApp(Python4CPMHandler):
+class MyRotator(Python4CPMHandler):
     def verify(self):
         # TODO: Add your logic here
         self.close_success()
@@ -351,7 +349,7 @@ class MyApp(Python4CPMHandler):
         # TODO: Add your logic here
         self.close_success()
 
-MyApp().run()
+MyRotator().run()
 ```
 
 #### Using Python4CPM properties and methods directly:
@@ -367,6 +365,7 @@ p4cpm.close_success()
 
 #### Remember for your final script:
 
-- Change the definition of `p4cpm` from `p4cpm = NETHelper.get()` to `p4cpm = Python4CPM("MyApp")` if you are using the properties and methods directly.
-- Remove any secrets prompting or interactive interruptions.
 - Remove the import of `NETHelper`.
+- Remove the `NETHelper.set()` call.
+- If applicable, change the definition of `p4cpm` from `p4cpm = NETHelper.get()` to `p4cpm = Python4CPM("MyApp")`.
+- Remove any secrets prompting or interactive interruptions.

{python4cpm-1.0.22 → python4cpm-1.0.23}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python4cpm"
-version = "1.0.22"
+version = "1.0.23"
 description = "Python for CPM"
 authors = [
   { name = "Gonzalo Atienza Rela", email = "gonatienza@gmail.com" }
@@ -12,7 +12,8 @@ authors = [
 dependencies = []
 requires-python = ">=3.10"
 readme = { file = "README.md", content-type = "text/markdown" }
-license = { file = "LICENSE" }
+license = "MIT"
+license-files = ["LICENSE"]
 
 [tool.setuptools]
 package-dir = { "" = "src" }

python4cpm-1.0.23/src/python4cpm/logger.py

@@ -0,0 +1,44 @@
+import os
+import logging
+from logging.handlers import RotatingFileHandler
+
+
+class Logger:
+    _LOGS_DIR = os.path.join("Logs", "ThirdParty")
+    _LOGGING_ENABLED_VALUE = "yes"
+    _LOGGING_LEVELS = {
+        "info": logging.INFO,
+        "debug": logging.DEBUG
+    }
+
+    @classmethod
+    def get_logger(
+        cls,
+        name: str,
+        args_logging: str,
+        args_logging_level: str
+    ) -> logging.Logger:
+        if args_logging.lower() != cls._LOGGING_ENABLED_VALUE:
+            return None
+        os.makedirs(cls._LOGS_DIR, exist_ok=True)
+        logs_file = os.path.join(cls._LOGS_DIR, f"{__name__}-{name}.log")
+        _id = os.urandom(4).hex()
+        logger = logging.getLogger(_id)
+        if args_logging_level.lower() in cls._LOGGING_LEVELS:
+            logger.setLevel(cls._LOGGING_LEVELS[args_logging_level.lower()])
+        else:
+            logger.setLevel(cls._LOGGING_LEVELS["info"])
+        handler = RotatingFileHandler(
+            filename=logs_file,
+            maxBytes=1024 ** 2,
+            backupCount=1
+        )
+        fmt = (
+            "%(asctime)s.%(msecs)03d | %(levelname)s | %(name)s | "
+            "%(module)s | %(funcName)s | %(message)s"
+        )
+        datefmt = "%Y-%m-%d %H:%M:%S"
+        formatter = logging.Formatter(fmt=fmt, datefmt=datefmt)
+        handler.setFormatter(formatter)
+        logger.addHandler(handler)
+        return logger

{python4cpm-1.0.22 → python4cpm-1.0.23}/src/python4cpm/python4cpm.py

@@ -3,7 +3,7 @@ import sys
 import atexit
 from python4cpm.secrets import Secrets
 from python4cpm.args import Args
-from python4cpm.logger import get_logger
+from python4cpm.logger import Logger
 
 
 class Python4CPM:
@@ -27,15 +27,16 @@ class Python4CPM:
     def __init__(self, name: str) -> None:
         self._name = name
         self._args = self._get_args()
-        self._logger = get_logger(
+        self._logger = Logger.get_logger(
             self._name,
             self._args.logging,
             self._args.logging_level
         )
-        self.log_info("Python4CPM.__init__: initiating...")
-        self._log_args()
+        self.log_debug("Initiating...")
+        self._log_env(self._args, False)
         self._verify_action()
         self._secrets = self._get_secrets()
+        self._log_env(self._secrets)
         self._closed = False
         atexit.register(self._on_exit)
 
@@ -49,19 +50,19 @@ class Python4CPM:
 
     def log_debug(self, message: str) -> None:
         if self._logger is not None:
-            self._logger.debug(message)
+            self._logger.debug(message, stacklevel=2)
 
     def log_info(self, message: str) -> None:
         if self._logger is not None:
-            self._logger.info(message)
+            self._logger.info(message, stacklevel=2)
 
     def log_warning(self, message: str) -> None:
         if self._logger is not None:
-            self._logger.warning(message)
+            self._logger.warning(message, stacklevel=2)
 
     def log_error(self, message: str) -> None:
         if self._logger is not None:
-            self._logger.error(message)
+            self._logger.error(message, stacklevel=2)
 
     @classmethod
     def _get_env_key(cls, key: str) -> str:
@@ -80,46 +81,41 @@ class Python4CPM:
         for secret in Secrets.SECRETS:
             _secret = os.environ.get(self._get_env_key(secret))
             secrets[secret] = _secret if _secret is not None else ""
-            common_message = f"Python4CPM._get_secrets: {secret} ->"
-            if secrets[secret]:
-                self.log_info(f"{common_message} [SET]")
-            else:
-                self.log_info(f"{common_message} [NOT SET]")
         return Secrets(**secrets)
 
     def _verify_action(self) -> None:
         if self._args.action not in self._VALID_ACTIONS:
-            self.log_warning(
-                f"Python4CPM._verify_action: unkonwn action -> {self._args.action}"
-            )
+            self.log_warning(f"Unkonwn action -> '{self._args.action}'")
 
-    def _log_args(self) -> None:
-        for key, value in vars(self._args).items():
-            common_message = f"Python4CPM._log_args: {key.strip('_')} ->"
+    def _log_env(self, obj: object, masked: bool = True) -> None:
+        for key, value in vars(obj).items():
+            _key = key.strip('_')
             if value:
-                self.log_info(f"{common_message} {value}")
+                if masked:
+                    logging_value = "[SET]"
+                else:
+                    logging_value = value
             else:
-                self.log_info(f"{common_message} [NOT SET]")
+                logging_value = "[NOT SET]"
+            self.log_debug(f"{_key} -> '{logging_value}'")
 
     def close_fail(self, unrecoverable: bool = False) -> None:
         if unrecoverable is False:
             code = self._FAILED_RECOVERABLE_CODE
         else:
             code = self._FAILED_UNRECOVERABLE_CODE
-        self.log_error(f"Python4CPM.close_fail: closing with code {code}")
+        self.log_error(f"Closing with code {code}")
         self._closed = True
         sys.exit(code)
 
     def close_success(self) -> None:
-        self.log_info(
-            f"Python4CPM.close_success: closing with code {self._SUCCESS_CODE}"
-        )
+        self.log_debug(f"Closing with code {self._SUCCESS_CODE}")
         self._closed = True
         sys.exit(self._SUCCESS_CODE)
 
     def _on_exit(self):
         if self._closed is False:
-            message = "Python4CPM._on_exit: no close signal called"
+            message = "No close signal called"
             self.log_error(message)
             sys.stderr.write(message)
             sys.stderr.flush()

{python4cpm-1.0.22 → python4cpm-1.0.23/src/python4cpm.egg-info}/PKG-INFO

@@ -1,30 +1,9 @@
 Metadata-Version: 2.4
 Name: python4cpm
-Version: 1.0.22
+Version: 1.0.23
 Summary: Python for CPM
 Author-email: Gonzalo Atienza Rela <gonatienza@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2026 Gonzalo Atienza Rela
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in
-        all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-        THE SOFTWARE.
-        
+License-Expression: MIT
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -32,7 +11,7 @@ Dynamic: license-file
 
 # Python4CPM
 
-A simple way of using python scripts with CyberArk CPM rotations.  This module leverages the [Credential Management .NET SDK](https://docs.cyberark.com/privilege-cloud-standard/latest/en/content/pasimp/plug-in-netinvoker.htm) from CyberArk to securely offload a password rotation logic into a python script.
+A simple way of using python scripts with CyberArk CPM/SRS rotations.  This module leverages the [Credential Management .NET SDK](https://docs.cyberark.com/privilege-cloud-standard/latest/en/content/pasimp/plug-in-netinvoker.htm) from CyberArk to securely offload a password rotation logic into a python script.
 
 This platform allows you to duplicate it multiple times, simply changing its settings from Privilege Cloud/PVWA to point to different python scripts leveraging the module `python4cpm`.
 
@@ -40,14 +19,14 @@ This platform allows you to duplicate it multiple times, simply changing its set
 
 ### Preparing Python
 
-1. Install Python in CPM.
+1. Install Python along CPM or the SRS Connector Management Agent.
     - **Python must be installed for all users**.  Follow the custom install steps from the installation wizard to check the checkbox.
-3. Create a venv in CPM, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
+3. Create a venv in the server, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
 4. 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 `python4cpm-*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
-        - Copy the file to CPM and extract to a temporary directory called `python4cpm-wheel`.
+        - Copy the file to the server into a temporary directory called `python4cpm-wheel`.
         - From the parent directory of `python4cpm-wheel` run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 
 
@@ -84,7 +63,7 @@ This platform allows you to duplicate it multiple times, simply changing its set
 from python4cpm import Python4CPMHandler
 
 
-class MyApp(Python4CPMHandler): # create a subclass for the Handler
+class MyRotator(Python4CPMHandler): # create a subclass for the Handler
     """
     These are the usable properties and methods from Python4CPMHandler:
     
@@ -101,13 +80,13 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
 
     Logging methods -> Will only log if PythonLogging (platform parameters) is set to yes (default is yes)
     
-        self.log_error("this is an error message") # logs error into Logs/ThirdParty/MyApp.log
-        self.log_warning("this is a warning message") # logs warning into Logs/ThirdParty/MyApp.log
-        self.log_info("this is an info message") # logs info into Logs/ThirdParty/MyApp.log
+        self.log_error("this is an error message") # logs error into Logs/ThirdParty/MyRotator.log
+        self.log_warning("this is a warning message") # logs warning into Logs/ThirdParty/MyRotator.log
+        self.log_info("this is an info message") # logs info into Logs/ThirdParty/MyRotator.log
     
     Logging level -> Will only log debug messages if PythonLoggingLevel (platform parameters) is set to debug (default is info)
     
-        self.log_debug("this is an debug message") # logs info into Logs/ThirdParty/MyApp.log if logging level is set to debug
+        self.log_debug("this is an debug message") # logs info into Logs/ThirdParty/MyRotator.log if logging level is set to debug
 
     =============================
     REQUIRED TERMINATION SIGNALS
@@ -160,9 +139,9 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
             # for your logic in a verification
         result = True
         if result is True:
-            self.log_info("verification successful") # logs info message into Logs/ThirdParty/MyApp.log
+            self.log_info("verification successful") # logs info message into Logs/ThirdParty/MyRotator.log
         else:
-            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyApp.log
+            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyRotator.log
             self.close_fail()
 
     def _change(self, from_reconcile=False):
@@ -176,26 +155,26 @@ class MyApp(Python4CPMHandler): # create a subclass for the Handler
             # self.secrets.reconcile_password.get() and self.secrets.new_password.get() for your logic in a reconciliation
         result = True
         if result is True:
-            self.log_info("rotation successful") # logs info message into Logs/ThirdParty/MyApp.log
+            self.log_info("rotation successful") # logs info message into Logs/ThirdParty/MyRotator.log
         else:
-            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyApp.log
+            self.log_error("something went wrong") # logs error message Logs/ThirdParty/MyRotator.log
             self.close_fail()
 
 
 if __name__ == "__main__":
-    MyApp().run() # initializes the class and calls the action that was requested from CPM/SRS.
+    MyRotator().run() # initializes the class and calls the action that was requested from CPM/SRS.
 ```
 (*) More realistic examples can be found [here](https://github.com/gonatienza/python4cpm/blob/main/examples/python4cpmhandler).
 
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
-1. Verify -> the sciprt will be executed once with the `MyApp.verify()` method.
-2. Change -> the sciprt will be executed twice, once with the action `MyApp.logon()` method and once as `MyApp.change()` method.
-    - If all actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
-3. Reconcile -> the sciprt will be executed twice, once with the action `MyApp.prereconcile()` method and once as `MyApp.reconcile()` method.
-    - If all actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
-4. When calling `MyApp.logon()` or `MyApp.prereconcile()`: `self.secrets.new_password.get()` will always return an empty string.
-5. If a logon account is not linked, `self.args.logon_username` and `self.secrets.logon_password.get()` will return an empty string.
-6. If a reconcile account is not linked, `self.args.reconcile_username` and `self.secrets.reconcile_password.get()` will return an empty string.
+1. Verify -> the sciprt will be executed once running the `MyRotator.verify()` method.
+2. Change -> the sciprt will be executed twice, running first the `MyRotator.logon()` method and secondly the `MyRotator.change()` method.
+    - If both actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
+3. Reconcile -> the sciprt will be executed twice, running first the `MyRotator.prereconcile()` method and secondly the `MyRotator.reconcile()` method.
+    - If both actions are not terminated with `self.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `self.close_fail(unrecoverable=True)`.
+4. When calling `MyRotator.verify()`, `MyRotator.logon()` or `MyRotator.prereconcile()`: `self.secrets.new_password.get()` will always return an empty string.
+5. If a logon account is not linked, `self.args.logon_username` and `self.secrets.logon_password.get()` will return empty strings.
+6. If a reconcile account is not linked, `self.args.reconcile_username` and `self.secrets.reconcile_password.get()` will return empty strings.
 
 
 ### Using Python4CPM properties and methods directly (for low level controls):
@@ -299,12 +278,12 @@ if __name__ == "__main__":
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
 1. Verify -> the sciprt will be executed once with the `p4cpm.args.action` as `Python4CPM.ACTION_VERIFY`.
 2. Change -> the sciprt will be executed twice, once with the action `p4cpm.args.action` as `Python4CPM.ACTION_LOGON` and once as `Python4CPM.ACTION_CHANGE`.
-    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
+    - If both actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
 3. Reconcile -> the sciprt will be executed twice, once with the `p4cpm.args.action` as `Python4CPM.ACTION_PRERECONCILE` and once as `Python4CPM.ACTION_RECONCILE`.
-    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
+    - If both actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, CPM/SRS will see this as a `p4cpm.close_fail(unrecoverable=True)`.
 4. When `p4cpm.args.action` comes as `Python4CPM.ACTION_VERIFY`, `Python4CPM.ACTION_LOGON` or `Python4CPM.ACTION_PRERECONCILE`: `p4cpm.secrets.new_password.get()` will always return an empty string.
-5. If a logon account is not linked, `p4cpm.args.logon_username` and `p4cpm.secrets.logon_password.get()` will return an empty string.
-6. If a reconcile account is not linked, `p4cpm.args.reconcile_username` and `p4cpm.secrets.reconcile_password.get()` will return an empty string.
+5. If a logon account is not linked, `p4cpm.args.logon_username` and `p4cpm.secrets.logon_password.get()` will return empty strings.
+6. If a reconcile account is not linked, `p4cpm.args.reconcile_username` and `p4cpm.secrets.reconcile_password.get()` will return empty strings.
 
 
 ### Installing dependencies in python venv
@@ -329,6 +308,8 @@ pip install python4cpm
 
 ### Example:
 
+#### Set your arguments and secrets:
+
 ```python
 from python4cpm import NETHelper, Python4CPM, Python4CPMHandler
 from getpass import getpass
@@ -339,11 +320,7 @@ password = getpass("password: ") # password from account
 logon_password = getpass("logon_password: ") # password from linked logon account
 reconcile_password = getpass("reconcile_password: ") # password from linked reconcile account
 new_password = getpass("new_password: ") # new password for the rotation
-```
-
-#### Set your arguments and secrets:
 
-```python
 NETHelper.set(
     action=Python4CPM.ACTION_LOGON, # use actions from Python4CPM.ACTION_*
     address="myapp.corp.local", # populate with the address from your account properties
@@ -362,7 +339,7 @@ NETHelper.set(
 #### Using the handler (recommended):
 
 ```python
-class MyApp(Python4CPMHandler):
+class MyRotator(Python4CPMHandler):
     def verify(self):
         # TODO: Add your logic here
         self.close_success()
@@ -383,7 +360,7 @@ class MyApp(Python4CPMHandler):
         # TODO: Add your logic here
         self.close_success()
 
-MyApp().run()
+MyRotator().run()
 ```
 
 #### Using Python4CPM properties and methods directly:
@@ -399,6 +376,7 @@ p4cpm.close_success()
 
 #### Remember for your final script:
 
-- Change the definition of `p4cpm` from `p4cpm = NETHelper.get()` to `p4cpm = Python4CPM("MyApp")` if you are using the properties and methods directly.
-- Remove any secrets prompting or interactive interruptions.
 - Remove the import of `NETHelper`.
+- Remove the `NETHelper.set()` call.
+- If applicable, change the definition of `p4cpm` from `p4cpm = NETHelper.get()` to `p4cpm = Python4CPM("MyApp")`.
+- Remove any secrets prompting or interactive interruptions.

python4cpm-1.0.22/src/python4cpm/logger.py

@@ -1,40 +0,0 @@
-import os
-import logging
-from logging.handlers import RotatingFileHandler
-
-
-_LOGS_DIR = os.path.join("Logs", "ThirdParty")
-_LOGGING_ENABLED_VALUE = "yes"
-_LOGGING_LEVELS = {
-    "info": logging.INFO,
-    "debug": logging.DEBUG
-}
-
-
-def get_logger(
-    name: str,
-    args_logging: str,
-    args_logging_level: str
-) -> logging.Logger:
-    if args_logging.lower() != _LOGGING_ENABLED_VALUE:
-        return None
-    os.makedirs(_LOGS_DIR, exist_ok=True)
-    logs_file = os.path.join(_LOGS_DIR, f"{__name__}-{name}.log")
-    _id = os.urandom(4).hex()
-    logger = logging.getLogger(_id)
-    if args_logging_level.lower() in _LOGGING_LEVELS:
-        logger.setLevel(_LOGGING_LEVELS[args_logging_level.lower()])
-    else:
-        logger.setLevel(_LOGGING_LEVELS["info"])
-    handler = RotatingFileHandler(
-        filename=logs_file,
-        maxBytes=1024 ** 2,
-        backupCount=1
-    )
-    formatter = logging.Formatter(
-        fmt="%(asctime)s | %(name)s | %(levelname)s | %(message)s",
-        datefmt="%Y-%m-%d %H:%M:%S"
-    )
-    handler.setFormatter(formatter)
-    logger.addHandler(handler)
-    return logger