Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.11.1

Jan 28, 2024

v1.11.0

Jan 14, 2024

v1.10.9

Jan 13, 2024

v1.10.8

Jan 11, 2024

v1.10.7

Dec 25, 2023

v1.10.6

Dec 25, 2023

Changes in this version

+ var ClientTimeout = 60

+ var ClientTokenFile = "/tmp/pwngrid-api-enrollment.json"

+ var Endpoint = ""

+ var ErrDecoding = errors.New("error decoding data")

+ var ErrEmpty = errors.New("")

+ var ErrEmptyMessage = errors.New("empty message body")

+ var ErrInvalidKey = errors.New("invalid public key")

+ var ErrInvalidSignature = errors.New("can't verify signature")

+ var ErrMessageNotFound = errors.New("message not found")

+ var ErrRecNotFound = errors.New("recipient not found")

+ var ErrSenderNotFound = errors.New("sender not found")

+ var ErrTokenClaims = errors.New("can't extract claims from jwt token")

+ var ErrTokenExpired = errors.New("jwt token expired")

+ var ErrTokenIncomplete = errors.New("jwt token is missing required fields")

+ var ErrTokenInvalid = errors.New("jwt token not valid")

+ var ErrTokenUnauthorized = errors.New("jwt token authorized field is false (?!)")

+ var ErrUnauthorized = errors.New("unauthorized")

+ func Authenticate(w http.ResponseWriter, r *http.Request) *models.Unit

+ func CORS(next http.Handler) http.Handler

+ func ERROR(w http.ResponseWriter, statusCode int, err error)

+ func JSON(w http.ResponseWriter, statusCode int, data interface{})

+ type API struct

+ Client *Client

+ Keys *crypto.KeyPair

+ Mesh *mesh.Router

+ Peer *mesh.Peer

+ Router *chi.Mux

+ func Setup(keys *crypto.KeyPair, peer *mesh.Peer, router *mesh.Router, Endpoint string) (err error, api *API)

+ func (api *API) GetInbox(w http.ResponseWriter, r *http.Request)

+ func (api *API) GetInboxMessage(w http.ResponseWriter, r *http.Request)

+ func (api *API) InboxMessage(id int) (map[string]interface{}, int, error)

+ func (api *API) ListUnits(w http.ResponseWriter, r *http.Request)

+ func (api *API) MarkInboxMessage(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerGetData(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerGetInbox(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerGetInboxMessage(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerGetMemory(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerGetMemoryOf(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerGetMeshData(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerGetPeers(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerListUnits(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerMarkInboxMessage(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerReportAP(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerSendMessageTo(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerSetData(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerSetMeshData(w http.ResponseWriter, r *http.Request)

+ func (api *API) PeerSetSignaling(w http.ResponseWriter, r *http.Request)

+ func (api *API) Run(addr string)

+ func (api *API) SendMessage(fingerprint string, cleartext []byte) (int, error)

+ func (api *API) SendMessageTo(w http.ResponseWriter, r *http.Request)

+ func (api *API) ShowUnit(w http.ResponseWriter, r *http.Request)

+ func (api *API) UnitEnroll(w http.ResponseWriter, r *http.Request)

+ func (api *API) UnitReportAP(w http.ResponseWriter, r *http.Request)

+ func (api *API) UnitReportMultipleAP(w http.ResponseWriter, r *http.Request)

+ func (api *API) UnitsByCountry(w http.ResponseWriter, r *http.Request)

+ type Client struct

+ func NewClient(keys *crypto.KeyPair, endpoint string) *Client

+ func (c *Client) Data() map[string]interface{}

+ func (c *Client) Get(path string, auth bool) (map[string]interface{}, error)

+ func (c *Client) Inbox(page int) (map[string]interface{}, error)

+ func (c *Client) InboxMessage(id int) (map[string]interface{}, error)

+ func (c *Client) MarkInboxMessage(id int, mark string) (map[string]interface{}, error)

+ func (c *Client) PagedUnits(page int) (map[string]interface{}, error)

+ func (c *Client) Post(path string, what interface{}, auth bool) (map[string]interface{}, error)

+ func (c *Client) ReportAP(report interface{}) (map[string]interface{}, error)

+ func (c *Client) Request(method string, path string, data interface{}, auth bool) (map[string]interface{}, error)

+ func (c *Client) SendMessageTo(fingerprint string, msg Message) error

+ func (c *Client) SetData(newData map[string]interface{}) map[string]interface{}

+ func (c *Client) Unit(fingerprint string) (map[string]interface{}, error)

+ type Message struct

+ Data string

+ Signature string