33de701263
* refactor(atomicx): move outside the engine package
After merging probe-engine into probe-cli, my impression is that we have
too much unnecessary nesting of packages in this repository.
The idea of this commit and of a bunch of following commits will instead
be to reduce the nesting and simplify the structure.
While there, improve the documentation.
* fix: always use the atomicx package
For consistency, never use sync/atomic and always use ./internal/atomicx
so we can just grep and make sure we're not risking to crash if we make
a subtle mistake on a 32 bit platform.
While there, mention in the contributing guidelines that we want to
always prefer the ./internal/atomicx package over sync/atomic.
* fix(atomicx): remove unnecessary constructor
We don't need a constructor here. The default constructed `&Int64{}`
instance is already usable and the constructor does not add anything to
what we are doing, rather it just creates extra confusion.
* cleanup(atomicx): we are not using Float64
Because atomicx.Float64 is unused, we can safely zap it.
* cleanup(atomicx): simplify impl and improve tests
We can simplify the implementation by using defer and by letting
the Load() method call Add(0).
We can improve tests by making many goroutines updated the
atomic int64 value concurrently.
* refactor(fsx): can live in the ./internal pkg
Let us reduce the amount of nesting. While there, ensure that the
package only exports the bare minimum, and improve the documentation
of the tests, to ease reading the code.
* refactor: move runtimex to ./internal
* refactor: move shellx into the ./internal package
While there, remove unnecessary dependency between packages.
While there, specify in the contributing guidelines that
one should use x/sys/execabs instead of os/exec.
* refactor: move ooapi into the ./internal pkg
* refactor(humanize): move to ./internal and better docs
* refactor: move platform to ./internal
* refactor(randx): move to ./internal
* refactor(multierror): move into the ./internal pkg
* refactor(kvstore): all kvstores in ./internal
Rather than having part of the kvstore inside ./internal/engine/kvstore
and part in ./internal/engine/kvstore.go, let us put every piece of code
that is kvstore related into the ./internal/kvstore package.
* fix(kvstore): always return ErrNoSuchKey on Get() error
It should help to use the kvstore everywhere removing all the
copies that are lingering around the tree.
* sessionresolver: make KVStore mandatory
Simplifies implementation. While there, use the ./internal/kvstore
package rather than having our private implementation.
* fix(ooapi): use the ./internal/kvstore package
* fix(platform): better documentation
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/ooapi/apimodel"
|
|
"github.com/ooni/probe-cli/v3/internal/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,
|
|
}
|
|
}
|