Metadata-Version: 2.1
Name: pyaim
Version: 1.0.2
Summary: CyberArk Application Access Manager Client Library for Python 3
Home-page: https://github.com/infamousjoeg/pyaim
Author: Joe Garcia
Author-email: joe.garcia@cyberark.com
License: MIT
Project-URL: Bug Reports, https://github.com/infamousjoeg/pyaim/issues/new?assignees=&labels=&template=bug_report.md&title=
Project-URL: Feature Requests, https://github.com/infamousjoeg/pyaim/issues/new?assignees=&labels=&template=feature_request.md&title=
Project-URL: Source, https://github.com/infamousjoeg/pyaim
Keywords: cyberark,security,vault,aim,aam,privileged access,identity,pam,pim,pas
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Topic :: Office/Business
Classifier: Topic :: Security
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown

# pyAIM <!-- OMIT IN TOC -->

![GitHub last commit](https://img.shields.io/github/last-commit/infamousjoeg/pyaim.svg) [![GitHub issues](https://img.shields.io/github/issues/infamousjoeg/pyaim.svg?color=blue)](https://github.com/infamousjoeg/pyaim/issues) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyaim.svg) ![GitHub top language](https://img.shields.io/github/languages/top/infamousjoeg/pyaim.svg?color=yellow)  [![PyPI](https://img.shields.io/pypi/v/pyaim.svg)](https://pypi.org/project/pyaim) [![PyPI - Downloads](https://img.shields.io/pypi/dm/pyaim.svg?color=blue)](https://pypi.org/project/pyaim) [![Keybase PGP](https://img.shields.io/keybase/pgp/infamousjoeg.svg)](https://keybase.io/infamousjoeg) [![GitHub](https://img.shields.io/github/license/infamousjoeg/pyaim.svg?color=blue)](LICENSE)

> 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.

## Table of Contents <!-- OMIT IN TOC -->

- [Install](#install)
  - [Pre-Requisite](#pre-requisite)
  - [Windows](#windows)
  - [Linux](#linux)
    - [Ubuntu/Debian](#ubuntudebian)
      - [Install Latest Python 3](#install-latest-python-3)
      - [Install pyAIM via Pip](#install-pyaim-via-pip)
    - [RHEL/CentOS](#rhelcentos)
      - [Enable epel-release if using RHEL](#enable-epel-release-if-using-rhel)
      - [Install Latest Python 3](#install-latest-python-3-1)
        - [RHEL](#rhel)
        - [CentOS](#centos)
      - [Install pyAIM via Pip](#install-pyaim-via-pip-1)
  - [MacOS](#macos)
  - [Z/OS](#zos)
    - [Install Latest Python 3](#install-latest-python-3-2)
    - [Install pyAIM via Pip](#install-pyaim-via-pip-2)
- [Usage](#usage)
  - [Retrieve Account](#retrieve-account)
    - [Credential Provider (CLIPasswordSDK) Method](#credential-provider-clipasswordsdk-method)
- [Maintainer](#maintainer)
- [Contributing](#contributing)
- [License](#license)

## Install

### Pre-Requisite

* CyberArk Application Access Manager Credential Provider installed locally.

For information on how to install, please refer to CyberArk's Application Access Manager Installation Guide.

### Windows

[Install the Python 3 release for Windows](https://www.python.org/downloads/windows/)

`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

##### Enable epel-release if using RHEL

Follow the [EPEL Documentation](https://fedoraproject.org/wiki/EPEL#How_can_I_use_these_extra_packages.3F).

##### Install Latest Python 3

###### RHEL

`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

`pip 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](https://www.rocketsoftware.com/zos-open-source) for Z/OS

#### Install pyAIM via Pip

`pip install pyaim`

## Usage

### Retrieve Account

#### Credential Provider (CLIPasswordSDK) Method

```python
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']))
```

## Maintainer

[@infamousjoeg](https://github.com/infamousjoeg)

## 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](https://github.com/infamousjoeg/pyaim/issues) page.

Keep checking back for an update regarding open Contributions in the near future.

## License

[MIT](LICENSE) © Joe Garcia, CISSP


