aionyphe 3.0.2
Asynchronous Onyphe API and CLI
Requires Python: >=3.10
Keywords: onyphe, api, cli, asyncio

# aionyphe

Asynchronous API SDK and command line interface written in Python
for [Onyphe](https://www.onyphe.io). This software is cross-platform and works
on Linux, Mac and Windows.

Using asyncio enables the user to perform concurrent requests without the need
of threading or subprocessing. Be careful not to trigger the rate limiting
protection though.

## Setup

Setup is almost the same for Linux, Darwin and Windows.

```bash
# assuming 'python' is python 3 executable
python -m venv venv
source venv/bin/activate
pip install git+https://github.com/koromodako/aionyphe
# next line is for linux and darwin only
pip install uvloop
```

## Testing

There is no automated testing for now. Manual testing was performed using
Python 3.12.3 on Ubuntu 24.04. Assume all Python versions above 3.10 are supported.

## Documentation

There is no documentation for now but most of the code is documented.

## Coding rules

Code is formatted using [black](https://github.com/psf/black) and
[Pylint](https://pylint.org) is used to ensure most of the code is
[PEP8](https://www.python.org/dev/peps/pep-0008) compliant and error free.

## API Usage

### Direct connection

```python
from json import dumps
from asyncio import run
from getpass import getpass
from aionyphe import OnypheAPIClient, client_session

async def main():
    oql = 'category:datascan domain:google.com'
    api_key = getpass("Enter Onyphe API key: ")
    async with client_session(api_key) as client:
        api_client = OnypheAPIClient(client=client)
        async for _, result in api_client.export(oql):
            print(dumps(result))

if __name__ == '__main__':
    run(main())
```

### Proxy connection

```python
from json import dumps
from asyncio import run
from getpass import getpass
from aionyphe import OnypheAPIClient, OnypheAPIClientProxy, client_session

async def main():
    oql = 'category:datascan domain:google.com'
    api_key = getpass("Enter Onyphe API key: ")
    proxy = OnypheAPIClientProxy(
        scheme='http', host='squid.domain.tld', port=3128
    )
    async with client_session(api_key) as client:
        api_client = OnypheAPIClient(client=client, proxy=proxy)
        async for _, result in api_client.export(oql):
            print(dumps(result))

if __name__ == '__main__':
    run(main())
```

### Get a specific result page

```python
from json import dumps
from asyncio import run
from getpass import getpass
from aionyphe import OnypheAPIClient, client_session

async def main():
    oql = 'category:datascan domain:google.com'
    api_key = getpass("Enter Onyphe API key: ")
    async with client_session(api_key) as client:
        api_client = OnypheAPIClient(client=client)
        async for _, result in api_client.search(oql, page=2):
            print(dumps(result))

if __name__ == '__main__':
    run(main())
```

### A helper to iterate over pages

```python
from json import dumps
from asyncio import run
from getpass import getpass
from aionyphe import OnypheAPIClient, client_session, iter_pages

async def main():
    oql = 'category:datascan domain:google.com'
    api_key = getpass("Enter Onyphe API key: ")
    async with client_session(api_key) as client:
        api_client = OnypheAPIClient(client=client)
        async for _, result in iter_pages(api_client.search, [oql], 2, 4):
            print(dumps(result))

if __name__ == '__main__':
    run(main())
```

## Command Line Interface

### Usage

This client does not support as much features as the original Onyphe
[client](https://github.com/onyphe/client) written in Perl but it does allow
the user to pipe the output to another tool keeping the JSON-based pipe interface.

```bash
# get usage information
aionyphe -h
# get 'export' command usage
aionyphe export -h
# export data for given oql query
aionyphe export 'category:datascan domain:google.com'
# get your public ip address
aionyphe myip
# get information about your user account
aionyphe user | jq
# show pages 2 to 4 for search query
aionyphe search --first 2 --last 4 'category:datascan domain:google.com'
```

### Configuration File (optional)

`aionyphe` client can load configuration from a file depending on the operating
system being used.

| OS      | Configuration file              |
|:-------:|:--------------------------------|
| Linux   | `/home/{username}/.aionyphe`    |
| Darwin  | `/Users/{username}/.aionyphe`   |
| Windows | `C:\Users\{username}\.aionyphe` |

This configuration file shall contain a JSON object with optional key/value
pairs taken from this table :

| Key              | Value |
|:----------------:|:------|
| `scheme`         | "http" or "https" |
| `host`           | Onyphe API hostname |
| `port`           | Port as an integer in range 0 -> 65535 |
| `version`        | Onyphe API version |
| `api_key`        | Onyphe API key (warning: plaintext secret stored on disk!) |
| `proxy_scheme`   | "http" or "https" |
| `proxy_host`     | Proxy hostname |
| `proxy_port`     | Proxy port as an integer in range 0 -> 65535 |
| `proxy_username` | Proxy authentication username |
| `proxy_password` | Proxy authentication password (warning: plaintext secret stored on disk!) |
| `total`          | Maximal number of seconds for each request made to the API |
| `connect`        | Maximal number of seconds for acquiring a connection from pool |
| `sock_read`      | Maximal number of seconds for reading a portion of data from a peer |
| `sock_connect`   | Maximal number of seconds for connecting to a peer for a new connection |

Note: command line arguments override configuration file values.