amphora

Documentation

Overview

Copyright (c) 2021-2024 - for information on the respective copyright owner see the NOTICE file and/or the repository https://github.com/carbynestack/ephemeral.

SPDX-License-Identifier: Apache-2.0

Index

• type AbstractClient
• type Client
  • func NewClient(u url.URL) (*Client, error)
  • func (c *Client) CreateSecretShare(os *SecretShare) error
  • func (c *Client) GetSecretShare(id string, programIdentifier string) (SecretShare, error)
• type SecretShare
• type Tag

Types

type AbstractClient

type AbstractClient interface {
	GetSecretShare(string, string) (SecretShare, error)
	CreateSecretShare(*SecretShare) error
}

AbstractClient is an interface for object storage client.

type Client

type Client struct {
	URL        url.URL
	HTTPClient http.Client
}

Client is a client for Amphora.

func NewClient

func NewClient(u url.URL) (*Client, error)

NewClient returns a new Amphora client.

func (*Client) CreateSecretShare

func (c *Client) CreateSecretShare(os *SecretShare) error

CreateSecretShare creates a new secret share by sending a POST request against Amphora.

func (*Client) GetSecretShare

func (c *Client) GetSecretShare(id string, programIdentifier string) (SecretShare, error)

GetSecretShare creates a new secret share by sending a POST request against Amphora.

type SecretShare

type SecretShare struct {
	SecretID string `json:"secretId"`
	Data     string `json:"data"`
	Tags     []Tag  `json:"tags"`
}

SecretShare is a secret-shared value stored in Amphora.

type Tag

type Tag struct {
	ValueType string `json:"valueType"`
	Key       string `json:"key"`
	Value     string `json:"value"`
}

Tag defines a tag that could be assigned to an secret share.