Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dcbr committed Jan 5, 2024
1 parent 53fb77d commit 45328e1
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,20 +69,14 @@ This is the main package, the integrating one, the one that wraps everything up.

### Signers

Signers are small libraries that `@signpdf/signpdf` will call with a PDF and they will know how to provide an e-signature in return. Their output is then fed as the signature in the resulting document.
Signers are small libraries that `@signpdf/signpdf` will call with a PDF and they will know how to provide an e-signature in return. Their output is then fed as the signature in the resulting document. Example implementations of the abstract `Signer` base class are provided in the [WebCrypto](./packages/examples/src/webcrypto.js) and [WebCrypto-External](./packages/examples/src/webcrypto-external.js) examples, both leveraging the `WebCrypto` API.

#### [@signpdf/signer-p12](./packages/signer-p12)

[![npm version](https://badge.fury.io/js/@signpdf%2Fsigner-p12.svg)](https://badge.fury.io/js/@signpdf%2Fsigner-p12)

With the help of its [peerDependency `node-forge`](#node-forge) the P12 signer provides the actual cryptographic signing of a Buffer using a P12 certificate bundle. This is done in detached mode as required for PDF.

#### [@signpdf/signer-external](./packages/signer-external)

[![npm version](https://badge.fury.io/js/@signpdf%2Fsigner-external.svg)](https://badge.fury.io/js/@signpdf%2Fsigner-external)

With the help of its [dependency `PKI.js`](https://github.com/PeculiarVentures/PKI.js) the external signer provides the actual cryptographic signing of a Buffer using an external service, such as Azure keyvaults or smartcards. The connection with the external service still has to be implemented by subclasses, see e.g. the [WebCrypto example](./packages/examples/src/webcrypto.js).

### Placeholder helpers

A placeholder is the e-signature equivallent of the label "Sign here:......." in your paper document. They are a required part of the process of [Signing PDFs](#signing-pdf-in-simple-steps). Different projects acquire their PDFs differently so we try to support some helpers that know how to add e-signature placeholders.
Expand Down

0 comments on commit 45328e1

Please sign in to comment.