{"id":16603326,"url":"https://github.com/dbrgn/sekursranko","last_synced_at":"2025-09-28T16:30:52.558Z","repository":{"id":37773537,"uuid":"160217639","full_name":"dbrgn/sekursranko","owner":"dbrgn","description":"Sekurŝranko, an efficient and memory-safe Threema Safe server implementation in Rust.","archived":false,"fork":false,"pushed_at":"2024-09-18T12:59:33.000Z","size":286,"stargazers_count":17,"open_issues_count":3,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-12T10:42:23.938Z","etag":null,"topics":["backup","rust","threema","threema-safe","webservice"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dbrgn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-03T16:04:06.000Z","updated_at":"2024-09-18T12:58:35.000Z","dependencies_parsed_at":"2023-02-06T09:47:20.537Z","dependency_job_id":null,"html_url":"https://github.com/dbrgn/sekursranko","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbrgn%2Fsekursranko","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbrgn%2Fsekursranko/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbrgn%2Fsekursranko/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbrgn%2Fsekursranko/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbrgn","download_url":"https://codeload.github.com/dbrgn/sekursranko/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234452073,"owners_count":18834740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","rust","threema","threema-safe","webservice"],"created_at":"2024-10-12T00:49:26.754Z","updated_at":"2025-09-28T16:30:47.280Z","avatar_url":"https://github.com/dbrgn.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sekurŝranko\n\n![Icon](safe.png)\n\n[![CircleCI][circle-ci-badge]][circle-ci]\n\nAn efficient and memory-safe Threema Safe server implementation\nwritten in Rust.\n\nThis is a private project, not developed nor endorsed by Threema GmbH.\n\nThe server spec can be found in the [Cryptography\nWhitepaper](https://threema.ch/press-files/2_documentation/cryptography_whitepaper.pdf).\n\n\n## Features\n\nThe following features are implemented:\n\n- [x] Request config\n- [x] Download backups\n- [x] Upload backups\n- [x] Delete backups\n- [x] Settings configurable by user\n- [x] User agent validation\n\nTo be implemented:\n\n- [ ] Automatic cleanup of expired backups\n\nThe following feature is out of scope and should be handled by another server\ncomponent (e.g. Nginx):\n\n- [ ] Throttling\n- [ ] TLS termination\n\n\n## Docker\n\nThere is a [Docker image](https://hub.docker.com/r/dbrgn/sekursranko) for this\nproject:\n\n    docker run \\\n        -v /sekursranko:/tmp/sekursranko \\\n        -p 3000:3000 \\\n        docker.io/dbrgn/sekursranko:master\n\nConfig variables can be passed to the Docker image as uppercase env vars, for\nexample:\n\n    docker run -e MAX_BACKUP_BYTES=12345 (...)\n\nThe image for the `master` branch is re-built on every push. The image for the\nlatest release and the `master` branch is re-built every week.\n\nNote: The UID/GID of the user within the Docker image is fixed to 1337.\n\nNote: I do not offer any guarantees for this published image. It's purely\nprovided for convenience. For critical setups, build the image yourself.\n\n\n## Building\n\nTo make a release build:\n\n    cargo build --release\n\nYou will find the binary at `target/release/sekursranko`.\n\n\n## Testing\n\nSekurŝranko is thoroughly covered by unit tests and integration tests.\n\nTo run the tests:\n\n    cargo test\n\nIn case you want to enable logging:\n\n    RUST_LOG=sekursranko=trace cargo test\n\nTo run linting:\n\n    rustup component add clippy\n    cargo clippy --all-targets --all-features\n\n\n## Running\n\nSimply execute the binary with the `-c` or `--config` argument:\n\n    ./sekursranko --config config.toml\n\nYou can find an example configfile in this repository at `config.example.toml`.\n\nConfigure logging using the `RUST_LOG` env var:\n\n    RUST_LOG=sekursranko=debug ./sekursranko -c config.toml\n\n\n## Deployment Notes\n\nSekurŝranko is meant to be run behind a reverse proxy (e.g. Nginx) that does\nTLS termination. That's why it currently doesn't support TLS directly.\n\nNote that you cannot backup to a server without TLS from the Threema app.\n\n\n## Name\n\nThe name of this project is the Esperanto word for \"safe\". English-speaking\npeople might recognize the \"sekur-\" prefix (-\u003e secure), and German-speaking\npeople might recognize the \"-ŝranko\" suffix (-\u003e \"Schrank\", a cabinet).\n\n\n## License\n\nLicensed under either of\n\n * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or\n   http://www.apache.org/licenses/LICENSE-2.0)\n * MIT license ([LICENSE-MIT](LICENSE-MIT) or\n   http://opensource.org/licenses/MIT) at your option.\n\n**Contributing**\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall\nbe dual licensed as above, without any additional terms or conditions.\n\n\u003c!-- Badges --\u003e\n[circle-ci]: https://circleci.com/gh/dbrgn/sekursranko/tree/master\n[circle-ci-badge]: https://circleci.com/gh/dbrgn/sekursranko/tree/master.svg?style=shield\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbrgn%2Fsekursranko","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbrgn%2Fsekursranko","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbrgn%2Fsekursranko/lists"}