Categorygithub.com/Scalingo/go-plugins-helpersauthorization
package
1.4.0
Repository: https://github.com/scalingo/go-plugins-helpers.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
6
Dependents
0
Files
124 SLOC

# README

Docker authorization extension api.

Go handler to create external authorization extensions for Docker.

Usage

This library is designed to be integrated in your program.

  1. Implement the authorization.Plugin interface.
  2. Initialize a authorization.Handler with your implementation.
  3. Call either ServeTCP or ServeUnix from the authorization.Handler.

Example using TCP sockets:

  p := MyAuthZPlugin{}
  h := authorization.NewHandler(p)
  h.ServeTCP("test_plugin", ":8080")

Example using Unix sockets:

  p := MyAuthZPlugin{}
  h := authorization.NewHandler(p)
  u, _ := user.Lookup("root")
  gid, _ := strconv.Atoi(u.Gid)
  h.ServeUnix("test_plugin", gid)

Full example plugins

License

MIT

# Functions

NewHandler initializes the request handler with a plugin implementation.

# Constants

AuthZApiImplements is the name of the interface all AuthZ plugins implement.
AuthZApiRequest is the url for daemon request authorization.
AuthZApiResponse is the url for daemon response authorization.

# Structs

Handler forwards requests and responses between the docker daemon and the plugin.
Request holds data required for authZ plugins.
Response represents authZ plugin response.

# Interfaces

Plugin represent the interface a plugin must fulfill.

# Type aliases

PeerCertificate is a wrapper around x509.Certificate which provides a sane encoding/decoding to/from PEM format and JSON.