• noarch v0.5.1.dev14+gfc342f4.d20240424

conda install

pip install

anaconda-cloud-auth

A client library for Anaconda.cloud APIs to authenticate and securely store API keys. This library is used by other Anaconda.cloud client packages to provide a centralized auth capability for the ecosystem. You will need to use this package to login to Anaconda.cloud before utilizing one of the other client packages.

This package provides a requests client class that handles loading the API key for requests made to Anaconda Cloud services.

This package provides a Panel OAuth plugin called anaconda_cloud.

Installation

conda install anaconda-cloud-auth

Usage

In order to use this package or one of the other Anaconda.cloud client packages you must first login interactively. This can be done using the Python API or CLI.

To use anaconda-cloud-auth as a CLI you will need to install the anaconda-cloud package. Once installed you can use the anaconda CLI to login and logout of Anaconda Cloud.

❯ anaconda login --help

 Usage: anaconda login [OPTIONS]

 Login to your Anaconda account.

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --domain                  TEXT  [default: None]                                                                                │
│ --basic     --no-basic          Deprecated [default: no-basic]                                                                │
│ --force     --no-force          [default: no-force]                                                                            │
│ --help                          Show this message and exit.                                                                    │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

API Keys and tokens

When you login with anaconda-cloud-auth an auth token is stored at ~/.anaconda/keyring and is deleted when you logout. The auth token will need to be renewed once a year.

If you do not have interactive browser access, there are several options to generate an API token from a system where you have interactive access

• you can copy the ~/.anaconda/keyring file a system where you have successfully run anaconda login
• you can generate a raw API token using anaconda-cloud-curl:

anaconda curl --use-browser-token -X POST -d '{"scopes": ["cloud:read", "cloud:write"]}' api/iam/api-keys

This will write the API key to the terminal (the key below is fake)

{
  "api_key": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVC.eyJleHAiOjE3NDQxMjMwOTYsImtpZCI6IjUxNzE2MCIsInNjb3BlcyI6WyJjbG91ZDpyZWFkIiwiY2xvdWQ6d3JpdGUiXSwic3ViIjoiN2E5MWM0ZWYtYWJhNy00OGUxLTk0NDYtMTk0ZDhkYzZjODNkIiwidmVyIjoiYXBpOjEifQ.T1iMbWnWG7CU3oJJczhM8qjGuyja0udZdxLjmb-DY6_f3GmG-bnxb9yBSszUrAYebFibhxs4-b2EYZcDnjNGbhitFVVOv6E6TKW4WrLTaDTa74jDeU56Z4-YvA_mrmtgIN6dFKNvN8B75HzRpy2mQKbiwrpPk-Ev1KlNgob8O_Y7UqR25zBNDoaepW44EMKPYDYL3zgttX3WbKyWFBlUVnKBl89Evvm4QUbJLgp4fVy0CON4wKOy3nSOZRK7MZqmtsTuBsvG0nCV6pVAL0DxATZCNKdfsxS-eajvUFj2gDaIK_RDoDwp7NIL7Hg6PcIJPVJ3sk2oSDfAOhfgHqKeHQ",
  "expires_at": "2025-04-08T14:38:16.33000217Z",
  "id": "417160"
}

Save the value of "api_key" and set the ANACONDA_CLOUD_API_KEY environment variable to it on the non-interactive system.

Configuration

You can configure anaconda-cloud-auth by setting one or more ANACONDA_CLOUD_ environment variables or use a .env file. The .env file must be in your current working directory. An example template is provided in the repo, which contains the following options, which are the default values.

# Logging level
LOGGING_LEVEL="INFO"

# Base URL for all API endpoints
ANACONDA_CLOUD_API_DOMAIN="anaconda.cloud"

# Authentication settings
ANACONDA_CLOUD_AUTH_DOMAIN="id.anaconda.cloud"
ANACONDA_CLOUD_AUTH_CLIENT_ID="b4ad7f1d-c784-46b5-a9fe-106e50441f5a"

In addition to the variables above you can set the following

# API key to use for all requests, this will ignore the keyring token set by `anaconda login`
ANACONDA_CLOUD_API_KEY="<api-key>"

# Extra headers to use in all requests; must be parsable JSON format
ANACONDA_CLOUD_API_EXTRA_HEADERS='<json-parsable-dictionary>'

Python API

from anaconda_cloud_auth import login

login()

The login() function initiates a browser-based login flow. It will automatically open your browser and once you have completed the login flow it will store an API key on your system.

Typically, these API keys will have a one year expiration so you will only need to login once and requests using the client class will read the token from the keyring storage.

If you call login() while there is a valid (non-expired) API key no action is taken. You can replace the valid API key with login(force=True).

To remove the API key from your keyring storage use the logout() function.

from anaconda_cloud_auth import logout

logout()

Password-based flow (Deprecated)

WARNING: Password-based login flow will be disable in the near future.

You can login into Anaconda Cloud using username/password flow (non-browser) with the basic=True keyword argument. The login() function will interactively request your username and password before completing login and storing the API key.

from anaconda_cloud_auth import login

login(basic=True)

API requests

The BaseClient class is a subclass of requests.Session. It will automatically load the API key from the keyring on each request. If the API key is expired it will raise a TokenExpiredError.

The Client class can be used for non-authenticated requests, if the API key cannot be found and the request returns 401 or 403 error codes the LoginRequiredError will be raised.

from anaconda_cloud_auth.client import BaseClient

client = BaseClient()

response = client.get("/api/<endpoint>")
print(response.json())

BaseClient accepts the following optional arguments.

• domain: Domain to use for requests, defaults to anaconda.cloud
• api_key: API key to use for requests, if unspecified uses token set by anaconda login
• user_agent: Defaults to anaconda-cloud-auth/<package-version>
• api_version: Requested API version, defaults to latest available from the domain
• extra_headers: Dictionary or JSON string of extra headers to send in requests

To create a Client class specific to your package, subclass BaseClient and set an appropriate user-agent and API version for your needs. This is automatically done if you use the cookiecutter in this repository to create a new package.

from anaconda_cloud_auth.client import BaseClient
class Client(BaseClient):
    _user_agent = "anaconda-cloud-<package>/<version>"
    _api_version = "<api-version>"

Panel OAuth Provider

In order to use the anaconda_cloud auth plugin you will need an OAuth client ID (key) and secret. The client must be configured as follows

Set scopes: offline_access, openid, email, profile
Set redirect url to http://localhost:5006
Set grant type: Authorization Code
Set response types: ID Token, Token, Code
Set access token type: JWT
Set Authentication Method: HTTP Body

To run the app with the anaconda_cloud auth provider you will need to set several environment variables or command-line arguments. See the Panel OAuth documentation for more details

PANEL_OAUTH_PROVIDER=anaconda_cloud or --oauth-provider anaconda_cloud
PANEL_OAUTH_KEY=<key>               or --oauth-key=<key>
PANEL_OAUTH_SECRET=<secret>         or --oauth-secret=<key>
PANEL_COOKIE_SECRET=<cookie-name>   or --cookie-secret=<value>
PANEL_OAUTH_REFRESH_TOKENS=1        or --oauth-refresh-tokens
PANEL_OAUTH_OPTIONAL=1              or --oauth-optional

panel serve <arguments> ...

If you do not specify the .env file, the production configuration should be the default. Please file an issue if you see any errors.

Setup for development

Ensure you have conda installed. Then run:

make setup

Run the unit tests

make test

Run the unit tests across isolated environments with tox

make tox