55bdebe8b2
* internal/engine/ooapi: auto-generated API client * feat: introduce the callers abstraction * feat: implement API caching on disk * feat: implement cloneWithToken when we require login * feat: implement login * fix: do not cache all APIs * feat: start making space for more tests * feat: implement caching policy * feat: write tests for caching layer * feat: add integration tests and fix some minor issues * feat: write much more unit tests * feat: add some more easy unit tests * feat: add tests that use a local server While there, make sure many fields we care about are OK. * doc: write basic documentation * fix: tweak sentence * doc: improve ooapi documentation * doc(ooapi): other documentation improvements * fix(ooapi): remove caching for most APIs We discussed this topic yesterday with @FedericoCeratto. The only place where we want LRU caching is MeasurementMeta. * feat(ooapi): improve handling of errors during login This was also discussed yesterday with @FedericoCeratto * fix(swaggerdiff_test.go): temporarily disable Before I work on this, I need to tend onto other tasks. * fix(ootest): add one more test case We're going towards 100% coverage of this package, as it ought to be. * feat(ooapi): test cases for when the probe clock is off * fix(ooapi): change test to have 100% unittest coverage * feat: sync server and client APIs definition Companion PR: https://github.com/ooni/api/pull/218 * fix(ooapi): start testing again against API * fix(ooapi): only generate each file once * chore: set version to 3.7.0-alpha While there, make sure we don't always skip a currently failing riseupvpn test, and slightly clarify the readme. * fix(kvstore): less scoped error message
60 lines
1.8 KiB
Go
60 lines
1.8 KiB
Go
package ooapi
|
|
|
|
import (
|
|
"crypto/rand"
|
|
"encoding/base64"
|
|
"time"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/engine/ooapi/apimodel"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/runtimex"
|
|
)
|
|
|
|
// loginState is the struct saved in the kvstore
|
|
// to keep track of the login state.
|
|
type loginState struct {
|
|
ClientID string
|
|
Expire time.Time
|
|
Password string
|
|
Token string
|
|
}
|
|
|
|
func (ls *loginState) credentialsValid() bool {
|
|
return ls.ClientID != "" && ls.Password != ""
|
|
}
|
|
|
|
func (ls *loginState) tokenValid() bool {
|
|
return ls.Token != "" && time.Now().Add(60*time.Second).Before(ls.Expire)
|
|
}
|
|
|
|
// loginKey is the key with which loginState is saved
|
|
// into the key-value store used by Client.
|
|
const loginKey = "orchestra.state"
|
|
|
|
// newRandomPassword generates a new random password.
|
|
func newRandomPassword() string {
|
|
b := make([]byte, 48)
|
|
_, err := rand.Read(b)
|
|
runtimex.PanicOnError(err, "rand.Read failed")
|
|
return base64.StdEncoding.EncodeToString(b)
|
|
}
|
|
|
|
// newRegisterRequest creates a new RegisterRequest.
|
|
func newRegisterRequest(password string) *apimodel.RegisterRequest {
|
|
return &apimodel.RegisterRequest{
|
|
// The original implementation has as its only use case that we
|
|
// were registering and logging in for sending an update regarding
|
|
// the probe whereabouts. Yet here in probe-engine, the orchestra
|
|
// is currently only used to fetch inputs. For this purpose, we don't
|
|
// need to communicate any specific information. The code that will
|
|
// perform an update used to be responsible of doing that. Now, we
|
|
// are not using orchestra for this purpose anymore.
|
|
Platform: "miniooni",
|
|
ProbeASN: "AS0",
|
|
ProbeCC: "ZZ",
|
|
SoftwareName: "miniooni",
|
|
SoftwareVersion: "0.1.0-dev",
|
|
SupportedTests: []string{"web_connectivity"},
|
|
Password: password,
|
|
}
|
|
}
|