Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: building documenso part 2 #1083

Merged
merged 6 commits into from
Apr 9, 2024
Merged

Conversation

ElTimuro
Copy link
Member

@ElTimuro ElTimuro commented Apr 6, 2024

  • blog article "building documenso part 2"

Copy link
Contributor

coderabbitai bot commented Apr 6, 2024

Walkthrough

The updates aim to deepen the comprehension of digital signatures within Documenso's ecosystem. The changes begin by highlighting the pivotal role of signing certificates. Subsequently, a detailed exploration of signature validity delves into the complexities of eIDAS-compliant electronic signatures, emphasizing certificate levels, trusted lists, and the challenges associated with maintaining highly compliant digital signature solutions.

Changes

File Path Change Summary
.../blog/building-documenso-pt1.mdx Shifts focus to the importance of signing certificates and Documenso's handling of them.
.../blog/building-documenso-pt2.mdx Introduces complexities of signature validity, eIDAS regulation levels, and compliance challenges.

Recent Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between d97ab04 and e2987b3.
Files selected for processing (1)
  • apps/marketing/content/blog/building-documenso-pt2.mdx (1 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

vercel bot commented Apr 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
stg-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 9, 2024 2:14pm
stg-marketing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 9, 2024 2:14pm
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
prd-app ⬜️ Ignored (Inspect) Apr 9, 2024 2:14pm
prd-marketing ⬜️ Ignored (Inspect) Apr 9, 2024 2:14pm

Copy link

github-actions bot commented Apr 6, 2024

Thank you for following the naming conventions for pull request titles! 💚🚀

@ElTimuro ElTimuro changed the title Feat/building documenso part 2 feat: building documenso part 2 Apr 9, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 9

Actionable comments outside the diff hunks (7)
apps/marketing/content/blog/building-documenso-pt1.mdx (7)

Line range hint 28-28: Consider revising "on the topic of" to a more concise form for clarity.

- on the topic of signature validity
+ on signature validity

Line range hint 44-44: "In many cases" could be replaced with a less frequent alternative for variety.

- legally acceptable in many cases
+ legally acceptable in numerous instances

Line range hint 56-56: The term "endeavour" is British English; consider aligning with one variant of English throughout the document.

- incredibly complex endeavour
+ incredibly complex endeavor

Line range hint 62-62: Mixing "organisation" and "organization" within a single text can be confusing. Stick to one spelling variant for consistency.

- Advanced Personal Certificates for Companies/Organisations
+ Advanced Personal Certificates for Companies/Organizations

Line range hint 77-77: The repetition of "While" at the beginning of successive sentences can be rephrased for better flow.

- While this is our setup, for now, we have a bigger plan for this topic. While globally trusted SSL Certificates have been available for free, courtesy of Let’s Encrypt, for a while now, there is no such thing as document signing.
+ This is our current setup, but we have a bigger plan for this topic. Globally trusted SSL Certificates have been available for free, courtesy of Let’s Encrypt, for a while now, yet there is no such thing as free document signing.

Line range hint 79-79: Consider adding "please" for a more polite request.

- As always, let me know in the comments
+ As always, please let me know in the comments

Line range hint 88-88: The informal phrase "talk about" could be replaced with a more professional alternative.

- here we talk about a document
+ here we discuss a document


1. **Simple Electronic Signatures (Level 1/ SES):** This is just a visual signature or even a checkbox on a document.

2. **Advanded Electronic Signatures (Level 2/ AES)**: An actual crypographic signature (not just a seal on the whole document, but a specific signature), using a certificate linked to the identification data of the signer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the spelling mistake in "Advanded" to "Advanced".

- Advanded Electronic Signatures
+ Advanced Electronic Signatures

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
2. **Advanded Electronic Signatures (Level 2/ AES)**: An actual crypographic signature (not just a seal on the whole document, but a specific signature), using a certificate linked to the identification data of the signer.
2. **Advanced Electronic Signatures (Level 2/ AES)**: An actual crypographic signature (not just a seal on the whole document, but a specific signature), using a certificate linked to the identification data of the signer.

Correct the spelling mistake in "crypographic" to "cryptographic".

- An actual crypographic signature
+ An actual cryptographic signature

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
2. **Advanded Electronic Signatures (Level 2/ AES)**: An actual crypographic signature (not just a seal on the whole document, but a specific signature), using a certificate linked to the identification data of the signer.
2. **Advanded Electronic Signatures (Level 2/ AES)**: An actual cryptographic signature (not just a seal on the whole document, but a specific signature), using a certificate linked to the identification data of the signer.


A: No, it means the provider (Wisekey) is not on a list maintained by the EU. The cryptographic signature is just as strong as any other

For someone who does not deal with this stuff daily, this can be hard to comprehend. Whether you use a certificate you generated yourself, one generated by a certificate authority (CA) like Wisekey, or one by another on the EU trust list (e.g., Bundesdruckerei), the cryptographic security guaranteeing that the document has not been tampered with is always the same. Many providers like Documenso, DocuSign, PandaDoc, and Digisigner all use this method for their regular plans. That means if you were to run a document signed by them through the validator above, the result would be the same[1]. The interesting question is why? Why do it like this?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a synonym to avoid repetition and enhance the writing style.

- this can be hard to comprehend
+ this can be difficult to understand

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
For someone who does not deal with this stuff daily, this can be hard to comprehend. Whether you use a certificate you generated yourself, one generated by a certificate authority (CA) like Wisekey, or one by another on the EU trust list (e.g., Bundesdruckerei), the cryptographic security guaranteeing that the document has not been tampered with is always the same. Many providers like Documenso, DocuSign, PandaDoc, and Digisigner all use this method for their regular plans. That means if you were to run a document signed by them through the validator above, the result would be the same[1]. The interesting question is why? Why do it like this?
For someone who does not deal with this stuff daily, this can be difficult to understand. Whether you use a certificate you generated yourself, one generated by a certificate authority (CA) like Wisekey, or one by another on the EU trust list (e.g., Bundesdruckerei), the cryptographic security guaranteeing that the document has not been tampered with is always the same. Many providers like Documenso, DocuSign, PandaDoc, and Digisigner all use this method for their regular plans. That means if you were to run a document signed by them through the validator above, the result would be the same[1]. The interesting question is why? Why do it like this?

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

/>

<figcaption className="text-center">
If a tree does not comply with the EU trust list, does it make a sound when validating?r
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider correcting the typo in "validating?r" to "validating?".

-    If a tree does not comply with the EU trust list, does it make a sound when validating?r
+    If a tree does not comply with the EU trust list, does it make a sound when validating?

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
If a tree does not comply with the EU trust list, does it make a sound when validating?r
If a tree does not comply with the EU trust list, does it make a sound when validating?


While there are some actual expenses involved in providing AES and QES, the blunt reality is that it's just good business to charge for them per signature, making it unsuitable for the "standard offerings"; almost no one has the resources to set this up themselves. While this initial process of becoming a QES-certified entity is really expensive, selling the certificates afterward is very lucrative. This leads to less innovation in the space and only big players providing these high-compliance services. Even certificates only used to seal documents without being QES certified are sold for a large range of prices, and they cost almost nothing to produce.

## Why Though?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the comma after "Why Though?" for correct punctuation in headings.

- ## Why Though?,
+ ## Why Though?

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## Why Though?
## Why Though?

\
\
\
[1] The signature format (e.g. PKCS7-B) will vary. It's the format what the signature inserted into the document looks like. eIDAS itself does not specifically require any given format, but the PAdES defined by the EU is mostly used by european providers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarify the sentence to improve readability.

- It's the format what the signature inserted into the document looks like.
+ It's the format that determines what the inserted signature looks like in the document.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
[1] The signature format (e.g. PKCS7-B) will vary. It's the format what the signature inserted into the document looks like. eIDAS itself does not specifically require any given format, but the PAdES defined by the EU is mostly used by european providers.
[1] The signature format (e.g. PKCS7-B) will vary. It's the format that determines what the inserted signature looks like in the document. eIDAS itself does not specifically require any given format, but the PAdES defined by the EU is mostly used by european providers.

@ElTimuro ElTimuro merged commit 6285ef2 into main Apr 9, 2024
12 of 13 checks passed
@ElTimuro ElTimuro deleted the feat/building-documenso-part-2 branch April 9, 2024 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apps: marketing Issues related to website or marketing app
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant