Menu

Regarding Documentation

Help
2020-03-26
2020-04-24
  • Aninda Chakrabarty

    Hello, I am very new to SignServer Community. I am trying to implement this Solution for the purpose of Signing PDF Document. During the process of reading the Documentation, I have found some inconsistencies in the documentation (I think) which I wanted to point out :-
    1. In the one of the Crypto - Worker Templates, I found a Property KEYSTORETYPE which is missing from Documentation.
    2. The CRYPTOTOKEN_IMPLEMENTATION_CLASS property is written as CRYPTOTOKEN_IMPLEMENTATION in the CryptoTokens Section --> https://doc.primekey.com/signserver520/signserver-reference/signserver-components/cryptotokens
    3. Even the Implementation Class org.signserver.server.cryptotokens.KeystoreCryptoToken is missing from the Documentation. Also wanted to know how this Implentation class differs from the JKSCryptoToken

    I am total newbie. I apologize in advance if am bothering all with these newbie questions.

     
  • Aninda Chakrabarty

    There is also an error in the name of the PDF Signer Worker Class Name. According to the Documentation it is org.signserver.module.PDFSigner (Link -- https://doc.primekey.com/signserver520/signserver-reference/signserver-workers/signserver-signers/pdf-signer) but upon implementating it returns the following error - Worker class not found (is the module included in the build?): org.signserver.module.PDFSigner: org.signserver.module.PDFSigner from [Module "deployment.signserver.ear.SignServer-ejb.jar" from Service Module Loader]

    It should be org.signserver.module.pdfsigner.PDFSigner which I found from the Prebuilt PDF Signer Template (pdfsigner.properties) which upon implementing works fine.

     
  • Markus Kilås

    Markus Kilås - 2020-04-24

    Hello Aninda,
    Thank you for sharing your findings regarding the documentation.

    Regarding 1. and 3., the thing is that internally there is one class KeyStoreCryptoToken which has the KEYSTORETYPE property. If you use a JKSCryptoToken then that is actually the same as KeyStoreCryptoToken+KEYSTORETYPE=JKS and if you use P12CryptoToken that is the same as KeyStoreCryptoToken+KEYSTORETYPE=PKCS12. I see that this can be confusing I am suggesting an improvement to instead mainly refer to the KeyStoreCryptoToken one and not the (old actually) JKS and P12CryptoTokens.

    Regarding 2, just that is not correct in the documentation. I guess most people are using the templates directly and did not look to closely at the documentation...

    Regarding PDFSigner, yes you are absolutely right here the class name is not correct.

    I have registered a ticket for fixing this issues in the documentation:
    https://jira.primekey.se/browse/DSS-2159

    Big thanks for contributing to making the project better!

    Cheers,
    Markus
    PrimeKey Solutions

     

Log in to post a comment.