Skip to content

ForkbombEu/signroom

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Signroom

Advanced electronic signature service based on Zenroom

cover







Signroom Features and Tech Stack

Signroom is generated using the Starters templating framework see the updated feature list and the tech stack there.

Document signing

  • Cades
  • Xades
  • Pades
  • Jades

Identity, Credential and cryptography

  • W3C-DID identity, based on Dyne.org W3C-DID method
  • W3C-VC: issueing and verification of credentials, via Web GUI and API

Cryptography powered by Zenroom:

  • Zero knowledge proof (Coconut, BBS)
  • Homomorphic multisignature based on Reflow
  • Cryptographic signatures (ECDSA, EDDSA, Schnorr, BBS, Ethereum signatures)
  • Quantum proof cryptography (Dilithium, Kyber, NTRUP)

Modularity

  • Expandable via no-code/low-code Web GUI, via the Admin Control Panel
  • Cryptography, computing and interoperability flows can be added using Zenroom and Restroom-mw
  • Pluggable to an external service via Zenswarm

Alpha Deployment


๐Ÿšฉ Table of Contents


๐ŸŽฎ Quick start

To start using Signroom run the following command in the root folder

docker compose up --build

After docker compose is done, in the bottom of the terminal you should read something like:

signroom-fe-1  |   โžœ  Local:   http://localhost:4173/
signroom-fe-1  |   โžœ  Network: http://192.168.0.233:4173/
signroom-fe-1  |   โžœ  Network: http://172.21.0.1:4173/

Then point your browser to http://localhost:4173 (currently it only works in localhost)

๐Ÿ” back to top


๐Ÿ’พ Build

(Development only) builds and launches the webapp and webapp, requires node >= 16

  1. git clone https://github.com/ForkbombEu/signroom/
  2. cd signroom
  3. git submodule update --init --recursive
  4. make up

Note: in order to get app working, database basic configuration is required (info coming soon).

DSS backend

Download the DSS backend from here

to run it in linux

chmod +x apache-tomcat-8.5.85/bin/*.sh
CATALINA_HOME=$PWD/apache-tomcat-8.5.85 ./apache-tomcat-8.5.85/bin/catalina.sh run

point your browser to http://localhost:8080

๐Ÿ” back to top


๐Ÿ‹ Docker

Coming soon

๐Ÿ” back to top


๐Ÿ API

Coming soon

๐Ÿ” back to top


๐Ÿ”ง Configuration

๐Ÿ” back to top


๐Ÿ“‹ Testing

๐Ÿ” back to top


๐Ÿ› Troubleshooting & debugging

๐Ÿ” back to top


๐Ÿ˜ Acknowledgements

Copyleft (ษ”) 2022 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to Mr. W. White for his special contributions.

Grants

Software written with the contribution of NGI Assure program run by NLNet:








๐Ÿ” back to top


๐ŸŒ Links

Shared docs Starter template Figma wireframes

๐Ÿ” back to top


๐Ÿ‘ค Contributing

  1. ๐Ÿ”€ FORK IT
  2. Create your feature branch git checkout -b feature/branch
  3. Commit your changes git commit -am 'Add some fooBar'
  4. Push to the branch git push origin feature/branch
  5. Create a new Pull Request
  6. ๐Ÿ™ Thank you

๐Ÿ” back to top


๐Ÿ’ผ License

Signroom - Advanced electronic signature service based on Zenroom
Copyleft (ษ”) 2022 Dyne.org foundation

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

๐Ÿ” back to top