Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mdouchement/standardfile

Yet Another Standardfile (standardnotes server) Implementation written in Golang
https://github.com/mdouchement/standardfile

client-library golang notes standard-notes standardfile standardnotes terminal-ui text-editor

Last synced: 3 days ago
JSON representation

Yet Another Standardfile (standardnotes server) Implementation written in Golang

Host: GitHub
URL: https://github.com/mdouchement/standardfile
Owner: mdouchement
License: mit
Created: 2019-04-07T17:27:43.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-12T19:48:23.000Z (4 months ago)
Last Synced: 2024-12-23T22:09:18.976Z (10 days ago)
Topics: client-library, golang, notes, standard-notes, standardfile, standardnotes, terminal-ui, text-editor
Language: Go
Homepage:
Size: 294 KB
Stars: 80
Watchers: 6
Forks: 9
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-standard-notes - Yet Another Standardfile - A Standard Notes Server implementation written in Go (Servers / Importers, Exporters, and Converters)

README

        # Yet Another Standardfile Implementation in Go

This project is **maintained for the basic features** as encrypted notes because on its own it already takes hours to figure out what is the issue when a breaking change or bug happens (e.g. [#87](https://github.com/mdouchement/standardfile/issues/87)).

People's pull requests that implement or fix extra features (revision, file storage, etc.) will be gladly reviewed and merged.

- For any bug linked to the code or its faulty behavior, please take a look to the existing [Issues](https://github.com/mdouchement/standardfile/issues) and feel free to open a new one if nothing match your issue

- For any question about this project, the configuration, integrations, related projects and so one, please take a look to the existing [Discussions](https://github.com/mdouchement/standardfile/discussions) and feel free to open a new one



[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/mdouchement/standardfile)

[![Go Report Card](https://goreportcard.com/badge/github.com/mdouchement/standardfile)](https://goreportcard.com/report/github.com/mdouchement/standardfile)

[![License](https://img.shields.io/github/license/mdouchement/standardfile.svg)](http://opensource.org/licenses/MIT)

This is a 100% Golang implementation of the [Standard Notes](https://docs.standardnotes.com/specification/sync) 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

```sh

go run cmd/sfc/main.go -h

```

Terminal UI client:

![sfc note](https://user-images.githubusercontent.com/6150317/62490536-c997f780-b7c9-11e9-867a-bc619d286b31.png)

## Requirements

- Golang 1.16.x (Go Modules)

### Technologies / Frameworks

- [Cobra](https://github.com/spf13/cobra)

- [Echo](https://github.com/labstack/echo)

- [BoltDB](https://github.com/etcd-io/bbolt) + [Storm](https://github.com/asdine/storm) Toolkit

- [Gowid](https://github.com/gcla/gowid)

## Differences with reference implementation

Drop legacy support for clients which hardcoded the "api" path to the base url (iOS)

> [Permalink](https://github.com/standardfile/ruby-server/blob/0a48c2625afc21966b110e0f73a1ff7bd212dbf4/config/routes.rb#L19-L26)

Drop the POST request done on Extensions (backups too)

> [Permalink](https://github.com/standardfile/ruby-server/blob/09b2020313a54668b7c6c0e122bbc8a530767d06/app/controllers/api/items_controller.rb#L20-L45)

This feature is pretty undocumented and I feel uncomfortable about the outgoing traffic from my server on unknown URLs.

Drop V1 support

> [All stuff used in v1 and not in v2 nor v3](https://github.com/standardfile/standardfile.github.io/blob/master/doc/spec-001.md)

JWT revocation strategy after password update

> Reference implementation use a [pw_hash](https://github.com/standardfile/ruby-server/blob/0a48c2625afc21966b110e0f73a1ff7bd212dbf4/app/controllers/api/api_controller.rb#L37-L43) 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 `iat` claim and `User.PasswordUpdatedAt` field.

> Looks more safer than publicly expose any sort of password stuff.

> See `internal/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.

1. Fork it

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

5. Push to the branch (git push origin my-new-feature)

6. Create new Pull Request