Skip to content

Commit 18e48ec

Browse files
authored
Merge pull request #114 from LFDT-Lockness/discord
Add info about discord
2 parents 84bd155 + f7574c6 commit 18e48ec

File tree

5 files changed

+88
-2
lines changed

5 files changed

+88
-2
lines changed

CONTRIBUTING.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing Guide
2+
3+
Thanks for taking interest to contributing to our project!
4+
5+
## Join us in Discord!
6+
We welcome all contributors to communicate with us [in Discord]! Please, reach out to us
7+
in `#lockness-contribute` room.
8+
9+
## Pull Requests
10+
Prior to making a PR, we ask you to communicate it with us, either [in Discord] or, if you
11+
prefer, by opening an issue in the repo. This would help to keep your work aligned with the
12+
maintainers view and avoid situations in which we can't accept your contribution.
13+
14+
All commits are required to be signed via verified GPG key. You can read about commit signing
15+
in [this series of articles](https://docs.github.com/en/authentication/managing-commit-signature-verification)
16+
(we recommend using a hardware GPG token).
17+
18+
All commits are required to be signed off by including `Signed-off-by: YOUR NAME <your_email@example.com>` line.
19+
By doing this, you certify that the commit is compliant with [Developer Certificate of Origin (DCO)](https://developercertificate.org/),
20+
meaning that you wrote the code or otherwise have the right to submit the code you are
21+
contributing to the project.
22+
23+
```text
24+
Developer Certificate of Origin
25+
Version 1.1
26+
27+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
28+
29+
Everyone is permitted to copy and distribute verbatim copies of this
30+
license document, but changing it is not allowed.
31+
32+
33+
Developer's Certificate of Origin 1.1
34+
35+
By making a contribution to this project, I certify that:
36+
37+
(a) The contribution was created in whole or in part by me and I
38+
have the right to submit it under the open source license
39+
indicated in the file; or
40+
41+
(b) The contribution is based upon previous work that, to the best
42+
of my knowledge, is covered under an appropriate open source
43+
license and I have the right under that license to submit that
44+
work with modifications, whether created in whole or in part
45+
by me, under the same open source license (unless I am
46+
permitted to submit under a different license), as indicated
47+
in the file; or
48+
49+
(c) The contribution was provided directly to me by some other
50+
person who certified (a), (b) or (c) and I have not modified
51+
it.
52+
53+
(d) I understand and agree that this project and the contribution
54+
are public and that a record of the contribution (including all
55+
personal information I submit with it, including my sign-off) is
56+
maintained indefinitely and may be redistributed consistent with
57+
this project or the open source license(s) involved.
58+
```
59+
60+
Commits can be automatically signed off automatically by using `-s` flag (i.e. `git commit -s`).
61+
62+
## Issues
63+
Feel free to open an issue if you found a bug, have a suggestion, or wish to
64+
communicate with us for other reasons.
65+
66+
However, if you want to report something that you believe might be a security
67+
vulnerability or a security flaw in this or any upstream project, please report
68+
it following the procedure described in [SECURITY.md](./SECURITY.md).
69+
70+
Feel free to reach out to us [in Discord] as well.
71+
72+
[in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
![License](https://img.shields.io/crates/l/cggmp21.svg)
44
[![Docs](https://docs.rs/cggmp21/badge.svg)](https://docs.rs/cggmp21)
55
[![Crates io](https://img.shields.io/crates/v/cggmp21.svg)](https://crates.io/crates/cggmp21)
6+
[![Discord](https://img.shields.io/discord/905194001349627914?logo=discord&logoColor=ffffff&label=Discord)][in Discord]
67

78
# Threshold ECDSA based on [CGGMP21] paper
89

@@ -21,6 +22,7 @@
2122
- [SPOF code: Key Import and Export](#spof-code-key-import-and-export)
2223
- [Differences between the implementation and CGGMP21](#differences-between-the-implementation-and-cggmp21)
2324
- [Timing attacks](#timing-attacks)
25+
- [Join us in Discord!](#join-us-in-discord)
2426

2527
<!-- TOC ENDS -->
2628

@@ -257,4 +259,9 @@ execution. We consider timing attacks out of scope as they are nearly impossible
257259
complicated protcol as CGGMP21 and impossible to do in our specific deployment. Thus, we intentionally
258260
don't do constant-time operations which gives us a significant performance boost.
259261

262+
## Join us in Discord!
263+
Feel free to reach out to us [in Discord]!
264+
265+
[in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388
266+
260267
<!-- cargo-rdme end -->

SECURITY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ We will evaluate the reported vulnerability, determine whether it needs to
1616
be addressed, and (if so) and provide an estimated timeline for addressing it.
1717

1818
After vulnerability was fixed and the new version of CGGMP21 protocol was
19-
properly tested, we publishe the fix, and publicly disclose the vulnerability
20-
(credits for finding the issue go to the reporter).
19+
properly tested, we publish the fix, and publicly disclose the vulnerability
20+
(credits for finding the issue go to the reporter).

cggmp21/src/lib.rs

+6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
//! ![License](https://img.shields.io/crates/l/cggmp21.svg)
22
//! [![Docs](https://docs.rs/cggmp21/badge.svg)](https://docs.rs/cggmp21)
33
//! [![Crates io](https://img.shields.io/crates/v/cggmp21.svg)](https://crates.io/crates/cggmp21)
4+
//! [![Discord](https://img.shields.io/discord/905194001349627914?logo=discord&logoColor=ffffff&label=Discord)][in Discord]
45
//!
56
//! # Threshold ECDSA based on [CGGMP21] paper
67
//!
@@ -282,6 +283,11 @@
282283
//! execution. We consider timing attacks out of scope as they are nearly impossible to perform for such
283284
//! complicated protcol as CGGMP21 and impossible to do in our specific deployment. Thus, we intentionally
284285
//! don't do constant-time operations which gives us a significant performance boost.
286+
//!
287+
//! ## Join us in Discord!
288+
//! Feel free to reach out to us [in Discord]!
289+
//!
290+
//! [in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388
285291
286292
#![allow(
287293
non_snake_case,

docs/toc-cggmp21.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@
1313
- [SPOF code: Key Import and Export](#spof-code-key-import-and-export)
1414
- [Differences between the implementation and CGGMP21](#differences-between-the-implementation-and-cggmp21)
1515
- [Timing attacks](#timing-attacks)
16+
- [Join us in Discord!](#join-us-in-discord)
1617

1718
<!-- TOC ENDS -->

0 commit comments

Comments
 (0)