README
¶
Yet Another Standardfile Implementation in Go
This is a 100% Golang implementation of the Standard File protocol. It aims to be portable and lightweight.
Running your own server
You can run your own Standard File server, and use it with any SF compatible client (like Standard Notes). This allows you to have 100% control of your data. This server implementation is built with Go and can be deployed in seconds.
https://hub.docker.com/r/mdouchement/standardfile
Client library
Go to pgk/libsf for more details.
https://godoc.org/github.com/mdouchement/standardfile/pkg/libsf
It is an alternative to https://github.com/jonhadfield/gosn
SF client
go run cmd/sfc/main.go -h
Terminal UI client:
Requirements
- Golang 1.11.x (Go Modules)
Technologies / Frameworks
Differences with reference implementation
Drop legacy support for clients which hardcoded the "api" path to the base url (iOS)
Drop the POST request done on Extensions (backups too)
This feature is pretty undocumented and I feel uncomfortable about the outgoing traffic from my server on unknown URLs.
Drop V1 support
JWT revocation strategy after password update
Reference implementation use a pw_hash claim to check if the user has changed their pw and thus forbid them from access if they have an old jwt.
Here we will revoke JWT based on its
iatclaim andUser.PasswordUpdatedAtfield. Looks more safer than publicly expose any sort of password stuff. Seeinternal/server/middlewares/current_user.go
Session use PASETO tokens instead of random tokens
Here we will be using PASETO to strengthen authentication to ensure that the tokens are issued by the server.
Not implemented (yet)
- 2FA (aka
verify_mfa) - Postgres if a more stronger database is needed
- A console for admin usage
License
MIT
Contributing
All PRs are welcome.
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
sfc
command
|
|
|
standardfile
command
|
|
|
internal
|
|
|
pkg
|
|
|
libsf
Create client client, err := libsf.NewDefaultClient("https://notes.nas.lan") if err != nil { log.Fatal(err) } Authenticate email := "george.abitbol@nas.lan" password := "12345678" auth, err := client.GetAuthParams(email) if err != nil { log.Fatal(err) } err = auth.IntegrityCheck() if err != nil { log.Fatal(err) } // Create keychain containing all the keys used for encryption and authentication.
|
Create client client, err := libsf.NewDefaultClient("https://notes.nas.lan") if err != nil { log.Fatal(err) } Authenticate email := "george.abitbol@nas.lan" password := "12345678" auth, err := client.GetAuthParams(email) if err != nil { log.Fatal(err) } err = auth.IntegrityCheck() if err != nil { log.Fatal(err) } // Create keychain containing all the keys used for encryption and authentication. |
|
tools
|
|
|
console
command
|
|
|
rmuser
command
|