CyberArk Application Access Manager Client Library for Python 3
Project description
pyAIM
CyberArk Application Access Manager Client Library for Python 3
This project simplifies the interaction between a Python 3 application or script and CyberArk's Application Access Manager's Credential Provider using the appropriate CLIPasswordSDK executable for the Operating System being used. By simplifying this process, developers are only required to change four (4) lines of code in their Python 3 applications and scripts to securely retrieve privileged secrets from CyberArk's Privileged Access Security (PAS) Core Solution as opposed to thirty or more (30+) without the use of this provided Client Library.
New in Version 1.1.0:
Now you can also use this with CyberArk's Application Access Manager Centralized Credential Provider (CCP) using REST API calls.
Table of Contents
Install
Pre-Requisite
Credential Provider (CLIPasswordSDK) Method
- CyberArk Application Access Manager Credential Provider installed locally.
Centralized Credential Provider (CCPPasswordREST) Method
- CyberArk Application Access Manager Centralized Credential Provider and AIMWebService
For information on how to install either of these providers, please refer to CyberArk's Application Access Manager Installation Guide or reach out to your assigned Customer Success Technical Advisor.
Windows
Install Latest Python 3
Install the Python 3 release for Windows
Install pyAIM via Pip
> pip3 install pyaim
Linux
Ubuntu/Debian
Install Latest Python 3
$ sudo apt install -y python3 python3-pip
Install pyAIM via Pip
$ pip3 install pyaim
RHEL/CentOS
Install Latest Python 3
RHEL
Follow the EPEL Documentation to ensure you have the EPEL Release repository available.
$ sudo yum install -y https://rhel7.iuscommunity.org/ius-release.rpm
$ sudo yum update
$ sudo yum install -y python36u python36u-libs python36u-devel python36u-pip
CentOS
$ sudo yum install -y https://centos7.iuscommunity.org/ius-release.rpm
$ sudo yum update
$ sudo yum install -y python36u python36u-libs python36u-devel python36u-pip
Install pyAIM via Pip
$ pip3 install pyaim
MacOS
No support provided yet.
Z/OS
pyAIM is untested on Z/OS but should work in theory.
Install Latest Python 3
Rocket Software has ported Python 2 and 3 for Z/OS
Install pyAIM via Pip
$ pip3 install pyaim
Usage
Check AIMWebService Availability - check_service()
Centralized Credential Provider (CCPPasswordREST) Method
from pyaim import CCPPasswordSDK
aimccp = CCPPasswordSDK('https://ccp.cyberarkdemo.example', verify=True) # set verify=False to ignore SSL
service_status = aimccp.check_service()
print(service_status)
Retrieve Account - GetPassword()
Credential Provider (CLIPasswordSDK) Method
from pyaim import CLIPasswordSDK
aimcp = CLIPasswordSDK('/opt/CARKaim/sdk/clipasswordsdk')
response = aimcp.GetPassword('appID','safeName','objectName')
print('Full Response: {}'.format(response))
print('Username: {}'.format(response['Username']))
print('Password: {}'.format(response['Password']))
print('Address: {}'.format(response['Address']))
print('Port: {}'.format(response['Port']))
print('PasswordChangeInProcess: {}'.format(response['PasswordChangeInProcess']))
Centralized Credential Provider (CCPPasswordREST) Method
from pyaim import CCPPasswordSDK
aimccp = CCPPasswordSDK('https://ccp.cyberarkdemo.example', verify=True) # set verify=False to ignore SSL
service_status = aimccp.check_service()
if service_status == 'AIMWebService Found. Status Code: 200':
response = aimccp.GetPassword('appid','safe','objectName')
print('Full Python Object: {}'.format(response))
print('Username: {}'.format(response['Username']))
print('Password: {}'.format(response['Content']))
else:
raise Exception(service_status)
Maintainer
Contributing
For the time being, only internal CyberArk contributions are being considered.
Feel free to report any feature requests or bugs on the GitHub Issues page.
Keep checking back for an update regarding open Contributions in the near future.
License
MIT © Joe Garcia, CISSP
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.