web

package

v0.17.1 Latest Latest Go to latest Published: Sep 19, 2023 License: Apache-2.0 Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mimiro-io/datahub-cli

Documentation ¶

Index ¶

Variables
func DeleteRequest(server string, token string, path string) error
func DoAdminLogin(cfg *config.Config) (*oauth2.Token, error)
func DoClientLogin(cfg *config.Config) (*oauth2.Token, error)
func ExportRsaPrivateKeyAsPem(key *rsa.PrivateKey) (string, error)
func ExportRsaPublicKeyAsPem(key *rsa.PublicKey) (string, error)
func GenerateRsaKeyPair() (*rsa.PrivateKey, *rsa.PublicKey)
func Get[T any](server string, token string, path string) (T, error)
func GetRequest(server string, token string, path string) ([]byte, error)
func GetServer() string
func GetServerFromAlias(alias string) string
func GetTokenWithClientCert(cfg *config.Config) (*oauth2.Token, error)
func GetValidToken(cfg *config.Config) (*oauth2.Token, error)
func InitialiseClientKeys() error
func ParseRsaPrivateKeyFromPem(pemValue []byte) (*rsa.PrivateKey, error)
func ParseRsaPublicKeyFromPem(pemValue []byte) (*rsa.PublicKey, error)
func PatchRequest(server string, token string, path string, content []byte) ([]byte, error)
func PostRequest(server string, token string, path string, content []byte) ([]byte, error)
func PostRequestWithHeaders(server string, token string, path string, content []byte, ...) ([]byte, error)
func Put[T any](server string, token string, path string) (T, error)
func PutRequest(server string, token string, path string) ([]byte, error)
func ResolveCredentials() (*oauth2.Token, error)
func ResolveCredentialsFromAlias(alias string) (*oauth2.Token, error)
type Client
- func NewClient(server string) (*Client, error)
- func (c *Client) Delete(endpoint string) error
- func (c *Client) DeleteRaw(path string) error
- func (c *Client) Get(endpoint string, response interface{}, headers ...Header) error
- func (c *Client) GetRaw(path string) ([]byte, error)
- func (c *Client) Post(endpoint string, request interface{}, response interface{}) error
- func (c *Client) PostRaw(path string, content []byte) ([]byte, error)
- func (c *Client) Put(endpoint string, request interface{}, response interface{}) error
- func (c *Client) PutRaw(path string) ([]byte, error)
type Header
type IdResponse
type KeyPair
- func NewKeyPair(privateKey *rsa.PrivateKey, publicKey *rsa.PublicKey, active bool) *KeyPair

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNotLoggedIn     = eris.New("user is not logged in")
	ErrFailedToMarshal = eris.New("failed to marshal the payload")
)

Functions ¶

func DeleteRequest ¶

func DeleteRequest(server string, token string, path string) error

func DoAdminLogin ¶

func DoAdminLogin(cfg *config.Config) (*oauth2.Token, error)

func DoClientLogin ¶ added in v0.14.0

func DoClientLogin(cfg *config.Config) (*oauth2.Token, error)

func ExportRsaPrivateKeyAsPem ¶

func ExportRsaPrivateKeyAsPem(key *rsa.PrivateKey) (string, error)

func ExportRsaPublicKeyAsPem ¶

func ExportRsaPublicKeyAsPem(key *rsa.PublicKey) (string, error)

func GenerateRsaKeyPair ¶

func GenerateRsaKeyPair() (*rsa.PrivateKey, *rsa.PublicKey)

func Get ¶ added in v0.17.0

func Get[T any](server string, token string, path string) (T, error)

Get is a shortcut for GetRequest but is using generics to make returning a struct easier

func GetRequest ¶

func GetRequest(server string, token string, path string) ([]byte, error)

func GetServer ¶

func GetServer() string

func GetServerFromAlias ¶

func GetServerFromAlias(alias string) string

func GetTokenWithClientCert ¶

func GetTokenWithClientCert(cfg *config.Config) (*oauth2.Token, error)

func GetValidToken ¶

func GetValidToken(cfg *config.Config) (*oauth2.Token, error)

func InitialiseClientKeys ¶

func InitialiseClientKeys() error

func ParseRsaPrivateKeyFromPem ¶

func ParseRsaPrivateKeyFromPem(pemValue []byte) (*rsa.PrivateKey, error)

func ParseRsaPublicKeyFromPem ¶

func ParseRsaPublicKeyFromPem(pemValue []byte) (*rsa.PublicKey, error)

func PatchRequest ¶

func PatchRequest(server string, token string, path string, content []byte) ([]byte, error)

func PostRequest ¶

func PostRequest(server string, token string, path string, content []byte) ([]byte, error)

func PostRequestWithHeaders ¶ added in v0.16.0

func PostRequestWithHeaders(server string, token string, path string, content []byte, headers map[string]string, timeout time.Duration) ([]byte, error)

func Put ¶ added in v0.17.0

func Put[T any](server string, token string, path string) (T, error)

Put is a shortcut for PutRequest but is using generics to make returning a struct easier

func PutRequest ¶

func PutRequest(server string, token string, path string) ([]byte, error)

func ResolveCredentials ¶

func ResolveCredentials() (*oauth2.Token, error)

func ResolveCredentialsFromAlias ¶

func ResolveCredentialsFromAlias(alias string) (*oauth2.Token, error)

Types ¶

type Client ¶

type Client struct {
	Server string
}

func NewClient ¶

func NewClient(server string) (*Client, error)

func (*Client) Delete ¶

func (c *Client) Delete(endpoint string) error

func (*Client) DeleteRaw ¶

func (c *Client) DeleteRaw(path string) error

func (*Client) Get ¶

func (c *Client) Get(endpoint string, response interface{}, headers ...Header) error

func (*Client) GetRaw ¶

func (c *Client) GetRaw(path string) ([]byte, error)

func (*Client) Post ¶

func (c *Client) Post(endpoint string, request interface{}, response interface{}) error

func (*Client) PostRaw ¶

func (c *Client) PostRaw(path string, content []byte) ([]byte, error)

func (*Client) Put ¶

func (c *Client) Put(endpoint string, request interface{}, response interface{}) error

func (*Client) PutRaw ¶

func (c *Client) PutRaw(path string) ([]byte, error)

type Header ¶

type Header struct {
	Header string
	Value  string
}

type IdResponse ¶

type IdResponse struct {
	Id uuid.UUID `json:"id"`
}

IdResponse can be used as a default response object where only an id is returned

type KeyPair ¶

type KeyPair struct {
	PrivateKey *rsa.PrivateKey
	PublicKey  *rsa.PublicKey
	Active     bool
	Expires    uint64
}

var ClientKeyPair *KeyPair

func NewKeyPair ¶

func NewKeyPair(privateKey *rsa.PrivateKey, publicKey *rsa.PublicKey, active bool) *KeyPair

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL