Struct oci_client::client::Client

pub struct Client { /* private fields */ }

The OCI client connects to an OCI registry and fetches OCI images.

An OCI registry is a container registry that adheres to the OCI Distribution specification. DockerHub is one example, as are ACR and GCR. This client provides a native Rust implementation for pulling OCI images.

Some OCI registries support completely anonymous access. But most require at least an Oauth2 handshake. Typically, you will want to create a new client, and then run the auth() method, which will attempt to get a read-only bearer token. From there, pulling images can be done with the pull_* functions.

For true anonymous access, you can skip auth(). This is not recommended unless you are sure that the remote registry does not require Oauth2.

Implementations

impl Client

pub fn new(config: ClientConfig) -> Self

Create a new client with the supplied config

pub fn from_source(config_source: &impl ClientConfigSource) -> Self

Create a new client with the supplied config

pub async fn store_auth_if_needed(&self, registry: &str, auth: &RegistryAuth)

Store the authentication information for this registry if it’s not already stored in the client.

Most of the time, you don’t need to call this method directly. It’s called by other methods (where you have to provide the authentication information as parameter).

But if you want to pull/push a blob without calling any of the other methods first, which would store the authentication information, you can call this method to store the authentication information manually.

pub async fn list_tags( &self, image: &Reference, auth: &RegistryAuth, n: Option<usize>, last: Option<&str>, ) -> Result<TagResponse>

Fetches the available Tags for the given Reference

The client will check if it’s already been authenticated and if not will attempt to do.

pub async fn pull( &self, image: &Reference, auth: &RegistryAuth, accepted_media_types: Vec<&str>, ) -> Result<ImageData>

Pull an image and return the bytes

The client will check if it’s already been authenticated and if not will attempt to do.

pub async fn push( &self, image_ref: &Reference, layers: &[ImageLayer], config: Config, auth: &RegistryAuth, manifest: Option<OciImageManifest>, ) -> Result<PushResponse>

Push an image and return the uploaded URL of the image

The client will check if it’s already been authenticated and if not will attempt to do.

If a manifest is not provided, the client will attempt to generate it from the provided image and config data.

Returns pullable URL for the image

pub async fn push_blob( &self, image_ref: &Reference, data: &[u8], digest: &str, ) -> Result<String>

Pushes a blob to the registry

pub async fn auth( &self, image: &Reference, authentication: &RegistryAuth, operation: RegistryOperation, ) -> Result<Option<String>>

Perform an OAuth v2 auth request if necessary.

This performs authorization and then stores the token internally to be used on other requests.

pub async fn fetch_manifest_digest( &self, image: &Reference, auth: &RegistryAuth, ) -> Result<String>

Fetch a manifest’s digest from the remote OCI Distribution service.

If the connection has already gone through authentication, this will use the bearer token. Otherwise, this will attempt an anonymous pull.

Will first attempt to read the Docker-Content-Digest header using a HEAD request. If this header is not present, will make a second GET request and return the SHA256 of the response body.

pub async fn pull_image_manifest( &self, image: &Reference, auth: &RegistryAuth, ) -> Result<(OciImageManifest, String)>

Pull a manifest from the remote OCI Distribution service.

The client will check if it’s already been authenticated and if not will attempt to do.

A Tuple is returned containing the OciImageManifest and the manifest content digest hash.

If a multi-platform Image Index manifest is encountered, a platform-specific Image manifest will be selected using the client’s default platform resolution.

pub async fn pull_manifest_raw( &self, image: &Reference, auth: &RegistryAuth, accepted_media_types: &[&str], ) -> Result<(Vec<u8>, String)>

Pull a manifest from the remote OCI Distribution service without parsing it.

The client will check if it’s already been authenticated and if not will attempt to do.

A Tuple is returned containing raw byte representation of the manifest and the manifest content digest.

pub async fn pull_manifest( &self, image: &Reference, auth: &RegistryAuth, ) -> Result<(OciManifest, String)>

Pull a manifest from the remote OCI Distribution service.

The client will check if it’s already been authenticated and if not will attempt to do.

A Tuple is returned containing the Manifest and the manifest content digest hash.

pub async fn pull_manifest_and_config( &self, image: &Reference, auth: &RegistryAuth, ) -> Result<(OciImageManifest, String, String)>

Pull a manifest and its config from the remote OCI Distribution service.

The client will check if it’s already been authenticated and if not will attempt to do.

A Tuple is returned containing the OciImageManifest, the manifest content digest hash and the contents of the manifests config layer as a String.

pub async fn push_manifest_list( &self, reference: &Reference, auth: &RegistryAuth, manifest: OciImageIndex, ) -> Result<String>

Push a manifest list to an OCI registry.

This pushes a manifest list to an OCI registry.

pub async fn pull_blob<T: AsyncWrite + Unpin>( &self, image: &Reference, layer: impl AsLayerDescriptor, out: T, ) -> Result<()>

Pull a single layer from an OCI registry.

This pulls the layer for a particular image that is identified by the given layer descriptor. The layer descriptor can be anything that can be referenced as a layer descriptor. The image reference is used to find the repository and the registry, but it is not used to verify that the digest is a layer inside of the image. (The manifest is used for that.)

pub async fn pull_blob_stream( &self, image: &Reference, layer: impl AsLayerDescriptor, ) -> Result<SizedStream>

Stream a single layer from an OCI registry.

This is a streaming version of Client::pull_blob. Returns SizedStream, which implements Stream or can be used directly to get the content length of the response

Example

use std::future::Future;
use std::io::Error;

use futures_util::TryStreamExt;
use oci_client::{Client, Reference};
use oci_client::client::ClientConfig;
use oci_client::manifest::OciDescriptor;

async {
  let client = Client::new(Default::default());
  let imgRef: Reference = "busybox:latest".parse().unwrap();
  let desc = OciDescriptor { digest: "sha256:deadbeef".to_owned(), ..Default::default() };
  let mut stream = client.pull_blob_stream(&imgRef, &desc).await.unwrap();
  // Check the optional content length
  let content_length = stream.content_length.unwrap_or_default();
  // Use as a stream
  stream.try_next().await.unwrap().unwrap();
  // Use the underlying stream
  let mut stream = stream.stream;
};

pub async fn pull_blob_stream_partial( &self, image: &Reference, layer: impl AsLayerDescriptor, offset: u64, length: Option<u64>, ) -> Result<BlobResponse>

Stream a single layer from an OCI registry starting with a byte offset. This can be used to continue downloading a layer after a network error. Please note that when doing a partial download (meaning it returns the BlobResponse::Partial variant), the layer digest is not verified as all the bytes are not available. The returned blob response will contain the header from the request digest, if it was set, that can be used (in addition to the digest from the layer) to verify the blob once all the bytes have been downloaded. Failure to do this means your content will not be verified.

Returns BlobResponse which indicates if the response was a full or partial response.

pub async fn mount_blob( &self, image: &Reference, source: &Reference, digest: &str, ) -> Result<()>

Mounts a blob to the provided reference, from the given source

pub async fn push_manifest( &self, image: &Reference, manifest: &OciManifest, ) -> Result<String>

Pushes the manifest for a specified image

Returns pullable manifest URL

pub async fn push_manifest_raw( &self, image: &Reference, body: Vec<u8>, content_type: HeaderValue, ) -> Result<String>

Pushes the manifest, provided as raw bytes, for a specified image

Returns pullable manifest url

pub async fn pull_referrers( &self, image: &Reference, artifact_type: Option<&str>, ) -> Result<OciImageIndex>

Pulls the referrers for the given image filtering by the optionally provided artifact type.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<ClientConfig> for Client

type Error = OciDistributionError

The type returned in the event of a conversion error.

fn try_from(config: ClientConfig) -> Result<Self, Self::Error>

Performs the conversion.