[−][src]Crate osauth
Asynchronous OpenStack session and authentication.
Introduction
This crate provides low-level asynchronous access to OpenStack API. It features:
- Authentication and token caching.
- Major and microversion handling.
- Service catalog integration.
- JSON API error handling.
- Service types for supported services.
It does NOT provide:
- Protocol structures for any services.
- Automatic microversion negotiation.
See openstack crate for these features.
Requirements
This crate requires Rust 2018 edition and relies heavily on
futures 0.1. It has not yet been updated for the new
async
/await
syntax and may not be compatible with it out-of-box.
Usage
Your entry point to the API is the Session structure. To create it you need an authentication type object first. It can be obtained by:
- Using Password authentication against the Identity service.
- Using NoAuth authentication type, allowing access to standalone services without authentication.
A Session
can be created directly by loading it:
- From the
clouds.yaml
configuration file using from_config. - From environment variables using from_env.
See Session documentation for the details on using a Session
for making
OpenStack calls.
If you need to work with a small number of servics, Adapter provides a
more convenient interface. An adapter can be created directly using
Adapter::new or from an existing Session
using
Session::adapter or
Session::into_adapter.
Modules
identity | Authentication using Identity API v3. |
request | Utilities to work with OpenStack requests. |
services | OpenStack service types. |
stream | A stream of resources. |
sync | Synchronous wrapper for a session. |
Structs
Adapter | Adapter for a specific service. |
ApiVersion | API version (major, minor). |
EndpointFilters | Endpoint filters for looking up endpoints. |
Error | Error from an OpenStack call. |
NoAuth | Authentication type that provides no authentication. |
Session | An OpenStack API session. |
ValidInterfaces | A list of acceptable interface types. |
Enums
ErrorKind | Kind of an error. |
InterfaceType | Interface type: public, internal or admin. |
Traits
AuthType | Trait for an authentication type. |
Functions
from_config | Create a |
from_env | Create a |