backend

package

v0.0.0-...-b446b8c Latest Latest Go to latest Published: Apr 7, 2020 License: MIT Imports: 8 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/Co-Epi/coepi-backend-go

Documentation ¶

Index ¶

Constants
func Computehash(data ...[]byte) []byte
type Backend
- func NewBackend(mysqlConnectionString string) (backend *Backend, err error)
type CENReport
- func GetSampleCENReportAndCENKeys(nKeys int) (cenReport *CENReport, cenKeys []string)

Constants ¶

View Source

const (
	// TableCENKeys stores the mapping between CENKeys and CENReports.
	TableCENKeys = "CENKeys"

	// TableCENKeys stores the mapping between CENKeys and CENReports.
	TableCENReport = "CENReport"

	// Default Conn String
	DefaultConnString = "[change this to your server]"
)

Variables ¶

This section is empty.

Functions ¶

func Computehash ¶

func Computehash(data ...[]byte) []byte

Computehash returns the hash of its inputs

Types ¶

type Backend ¶

type Backend struct {
	// contains filtered or unexported fields
}

Backend holds a client to connect to the BigTable backend

func NewBackend ¶

func NewBackend(mysqlConnectionString string) (backend *Backend, err error)

NewBackend sets up a client connection to BigTable to manage incoming payloads

func (*Backend) ProcessCENReport ¶

func (backend *Backend) ProcessCENReport(cenReport *CENReport) (err error)

ProcessCENReport manages the API Endpoint to POST /cenreport

Input: CENReport
Output: error
Behavior: write report bytes to "report" table; write row for each CENKey with reportID

func (*Backend) ProcessGetCENKeys ¶

func (backend *Backend) ProcessGetCENKeys(timestamp uint64) (cenKeys []string, err error)

ProcessGetCENKeys manages the GET API endpoint /cenkeys

Input: timestamp
Output: array of CENKeys (in string form) for the last hour

func (*Backend) ProcessGetCENReport ¶

func (backend *Backend) ProcessGetCENReport(cenKey string) (reports []*CENReport, err error)

ProcessGetCENReport manages the POST API endpoint /cenreport

Input: cenKey
Output: array of CENReports

type CENReport ¶

type CENReport struct {
	ReportID        string `json:"reportID,omitempty"`
	Report          []byte `json:"report,omitempty"`  // this is expected to be a JSON blob but the server doesn't need to parse it
	CENKeys         string `json:"cenKeys,omitempty"` // comma separated list of hex AES-128 Keys (COMMENT WAS: base64 AES Keys)
	ReportMimeType  string `json:"reportMimeType,omitempty"`
	ReportTimeStamp uint64 `json:"reportTimeStamp,omitempty"`
}

CENReport payload is sent by client to /cenreport when user reports symptoms

func GetSampleCENReportAndCENKeys ¶

func GetSampleCENReportAndCENKeys(nKeys int) (cenReport *CENReport, cenKeys []string)

GetSampleCENReportAndCENKeys generates a CENReport and an array of CENKeys (in string form)

Source Files ¶

View all Source files

backend.go

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