Signing​ ​Tool​ ​API​ ​Anatomy​ ​v1.0.0

This document is intended for Portal / Developers / Websites to integrate the API into their Web application​ ​and​ ​Desktop​ ​Application.

This helps the user in making their entire signing work easy and secured

Standard​ ​Disclaimer

  • The​ ​specification​ ​can​ ​always​ ​change​ ​at​ ​last​ ​minute.
  • This​ ​is​ ​intended​ ​for​ ​selected​ ​people​ ​and​ ​is​ ​confidential.

Anatomy​ ​of​ ​Command

Request​ ​Command

This​ ​is​ ​​ ​root​ ​element​ ​it​ ​contains​ ​following​ ​elements All​ ​these​ ​element​s are​ ​sent​ ​in​ <command> <ts> <txn> <certificate><file> <pdf> <data>

<ts>

This​ ​is​ ​Time​ ​Stamping​ ​element,​ ​which​ ​the​ ​server​ ​would​ ​pass​ ​to​ ​the​ ​Signing​ ​Tool. (This ​​ is ​Optional ​Element) The signing tool would compare with the Client system Date and time and see the difference, if​ ​there​ ​is​ ​difference​ for​​ ​30​ ​seconds​ ​from​ ​ ​Server​ ​Date​ ​and​ ​Time​ ​it​ ​would​ ​not​ ​Sign. ​

<txn>

A​ ​unique​ ​ID​ ​could​ ​be​ ​passed​ ​with​ ​each​ ​Signing​ ​Request,​ ​it​ ​would​ ​help​ ​Web​ ​Application​ ​to​ ​get​ ​the response​ ​and​ ​map​ ​it​ ​to​ ​correct​ ​request. (This ​is ​Optional ​Element)

<certificate>

The​ ​application​ ​could​ ​also​ ​pass​ ​values​ ​to​ ​prompt​ ​signing​ ​tool​ ​to​ ​match​ ​for​ ​a​ ​certificate​ ​present in​ ​Browser​ ​Store​ ​and​ ​operations​ ​could​ ​be​ ​performed. (This ​is ​Optional ​Element)

  • If there are more than One Signature matching the criteria, then a Box showing all the matching​ ​signature​ ​would​ ​be​ ​shown,​ ​and​ user​ ​could​ ​select​ ​signature.
  • If only One Signature is found, then our application would only show the pop up for Password​ ​and​ ​it​ ​would​ ​automatically​ ​sign.
  • If​ ​no​ ​Parameters​ ​are​ ​sent​ ​then​ ​all​ ​allowed​ ​certificate​ ​would​ ​be​ ​shown.

The <certificate> ​can​ ​used​ ​with​ ​the​ ​following​ ​attributes​ ​with​ ​this​ ​element.

<attribute​ ​name="CN"> John​ < /attribute>

<attribute​ ​name="O"> John​ ​&​ ​Company < /attribute>

<attribute​ ​name="OU">​ Management < /attribute>

<attribute​ ​name="T"> CEO​ < /attribute>

<attribute​ ​name="E"> SomeEmail@domain.com​ < /attribute>

<attribute​ ​name="SN">​ A123 < /attribute>

<attribute​ ​name="CA"> Capricorn​ ​CA​ < /attribute>

<attribute​ ​name="TC"> SG < /attribute>

<attribute​ ​name="AP"> application​ ​id​ < /attribute>

<attribute​ ​name="VD"> Application​ ​Validity​ ​Date​ < /attribute>

CN ​=​ ​Subject​ ​Name

O​ ​​=​ ​Organization​ ​name.

OU​ ​=​ ​Organization​ ​Unit.

T​ ​=​ ​Title E​ ​=​ ​eMail

SN​ ​​=​ ​​ ​Serial​ ​number.

CA​ ​​=​ ​Certifying​ ​Authority.

TC​ ​=​ ​​ ​Type​ ​of​ ​certificate,​ ​allowed​ ​variables​

​​SG​ ​​​(Signing)​

EN​​ ​​(Encryption)

AP ​=​ ​​ ​Application​ ​Id​ ​(​ ​This​ ​is​ ​intended​ ​for​ ​application​ ​developers​ ​)

VD​=​ ​Application​ ​Validity​ ​Date

<file>

type​ ​​=​ ​​ The​ ​Type​ ​of​ ​Data​ ​which​ ​needs​ ​to​ ​used​ ​by​ ​the​ ​commands (This ​is ​Mandatory​ Element) Allowed​ ​variables​ ​​PDF​,​ ​​TXT​ ​​or​ ​​XML

inputfile​ ​​=​ ​​Unsigned file path (full), which need to be signed ( This is Optional if you passing <data> element

outputfile​ ​​=​ ​​ ​Signed file copied here (optional)

<pdf>

This​ ​Element​ ​is​ ​used​ ​when​ ​<file> ​element​ ​is​ ​PDF (This ​is ​Optional ​Element)

  • This Element is is used when we would want to sign the PDF file in particular Page and in Particular​ ​Place.
  • In case no values are passed, the signing would happen in the file invisible form (No Physical​ ​footprint​ ​would​ ​left​ ​in​ ​file).
  • If the values are passed with <file> not equal to PDF the values present would not be affect the​ ​Signing​ ​process.
  • This​ ​element​ ​is​ ​used​ ​for​ ​Signing​ ​only.

The​ ​attributes​ ​available​ ​are:-

<page>1 < /page>

<cood​>10,10 < /cood>

<size​>200,200 < /size>

<invisiblesign​>yes < /invisiblesign>

<enableltv​>yes < /enableltv>

<enabletimestamp​​>yes < /enabletimestamp>

<page>

​Only​ ​Numeric,​ ​Zero​ ​is​ ​not​ ​allowed

<cood>

Only Numeric allowed, two numeric value allowed, it would try to sign the pixels mentioned (depending on the resolutions of the file saved), else it would generate an error. Please separate the value by a comma, The first figure is horizontal and the next figure is Vertical on the page​ ​(eg.​ ​79,100)

<size>

Only Numeric allowed, two numeric value allowed,and it would print the signature in the box mentioned here. Please separate the value by a comma, The first figure is horizontal and the next​ ​figure​ ​is​ ​Vertical​ ​on​ ​page​ ​(eg.​ ​79,100)

<invisiblesign>

For invisible signature. Allowed value are "yes" and "no"

<enableltv>

To enable the LTV. Allowed value are "yes" and "no"

<enabletimestamp>

To enable the embeded timestamp. Allowed value are "yes" and "no"

<data>

The​ ​actual​ ​data​ ​which​ ​is​ ​encoded​ ​in​ ​Base64​ ​format. (This ​is ​Mandatory ​Element)

<command>

This is the actual command to help you perform operations using our applications

S.No.
Command
Description
01
pkiNetworkSign
This​ ​command​ ​is​ ​used​ ​to​ ​Sign,​ ​XML,​ ​TEXT,​ ​PDF,​ ​​data​ ​has​ ​to be​ ​passed​ ​in​ ​Base64.
02
pkiNetworkSignHash
This​ ​command​ ​is​ ​used​ ​to​ ​sign​ ​Hash​ ​instead​ ​of​ ​sending​ ​the Base64​ ​File.
03
pkiNetworkVerSign
This​ ​command​ ​is​ ​used​ ​to​ ​Verify​ ​Signature.
  • You ​could ​pass ​any ​existing ​document ​(Text, ​PDF,​ XML), with attributes ​and ​it ​would ​verify signature.
04
pkiNetworkEnc
This​ ​command​ ​is​ ​used​ ​for​ ​Encryption​ ​of​ ​Data.
05
pkiNetworkDeEnc
This​ ​command​ ​is​ ​used​ ​for​ ​De​ ​Encryption​ ​of​ ​Data.
06
pkiNetworkCertExt
This​ ​command​ ​is​ ​used​ ​to​ ​extract​ ​details​ ​of​ ​the Certificate .
  • Response ​would ​be ​details ​of ​​certificate in ​XML format, ​No ​attributes ​can ​be ​passed
07
pkiNetworkCertAuth
This​ ​Command​ ​is​ ​used​ ​to​ ​validate​ ​data​ ​and​ ​Certificate details.
  • Response ​would ​be ​Valid / ​Not ​Valid, ​and ​you ​​ could pass ​all attributes.
08
pkiNetworkFileEnc
This​ ​command​ ​is​ ​used​ ​to​ ​encrypt​ ​file​ ​from​ ​the​ ​client​ ​machine, when​ ​the​ ​command​ ​is​ ​initiated​ ​it​ ​would​ ​open​ ​a​ ​File​ ​browser window,​ ​a​ ​file​ ​would​ ​be​ ​selected,​ ​the​ ​same​ ​file​ ​would​ ​be converted​ ​into​ ​Base64,​ ​and​ ​encrypted.
09
pkiNetworkFileEncSign
This​ ​command​ ​is​ ​used​ ​to​ ​encrypt​ ​file​ ​from​ ​the​ ​client​ ​machine, when​ ​the​ ​command​ ​is​ ​initiated​ ​it​ ​would​ ​open​ ​a​ ​File​ ​browser window,​ ​a​ ​file​ ​would​ ​be​ ​selected,​ ​the​ ​same​ ​file​ ​would​ ​be converted​ ​into​ ​Base64,​ ​and​ ​encrypted,​ ​then​ ​the​ ​same​ ​data would​ ​be​ ​signed​ ​with​ ​the​ ​selected​ ​DSC.
10
pkiNetworkEncSign
This​ ​command​ ​is​ ​used​ ​to​ ​encrypt​ ​Block​ ​of​ ​Text​ ​file​ ​and​ ​then the​ ​same​ ​data​ ​would​ ​be​ ​signed​ ​with​ ​the​ ​selected​ ​DSC.
11
pkiNetworkEncExt
This​ ​command​ ​is​ ​used​ ​​ ​extract​ ​the​ ​P7B​ ​file​ ​of​ ​the​ ​encryption certificate​ ​and​ ​the​ ​same​ ​would​ ​be​ ​converted​ ​into​ ​Base64​ ​and sent​ ​back​ ​as​ ​response.
12
pkiNetworkFileSign
This​ ​command​ ​is​ ​used​ ​to​ ​Sign​ ​file​ ​from​ ​the​ ​client​ ​machine, when​ ​the​ ​command​ ​is​ ​initiated​ ​it​ ​would​ ​open​ ​a​ ​File​ ​browser window,​ ​a​ ​file​ ​would​ ​be​ ​selected,​ ​the​ ​same​ ​file​ ​would​ ​be converted​ ​into​ ​Base64,​ ​and​ ​encrypted.

Sample​ ​Structure 

To make it easy for the developers to understand the whole procedure of using PKI, we have generated a sample structure here.

<request>

<command> pkiNetworkSign < /command>

<ts> 2017-03-22T12:23:11.3820412+05:30 < /ts>

<txn> unique​ ​id < /txn>

<certificate>

<attribute​ ​name="CN"> < /attribute>

<attribute​ ​name="O"> < /attribute>

<attribute​ ​name="OU">​< /attribute>

<attribute​ ​name="T"> < /attribute>

<attribute​ ​name="E"> < /attribute>

<attribute​ ​name="SN">​< /attribute>

<attribute​ ​name="CA">< /attribute>

<attribute​ ​name="TC"> sg/en< /attribute>

<attribute​ ​name="AP">< /attribute>

<attribute​ ​name="VD"> < /attribute>

< /certificate>

<file>

<attribute​ ​name="type"> xml/pdf/text < /attribute>

< /file>

<pdf>

<page> < /page>

<cood>78,56 < /cood>

<size> < /size>

< /pdf>

<data>

base64 ​encoded

< /data>

</request>

<response>

<command> pkiNetworkSign < /command>

<ts>2017-03-22T12:23:11.3820412+05:30 < /ts>

<txn> unique​ ​id < /txn>

<status> ok < /status>

<data>base64​ ​encoded < /data>

< /response>

Or

<response>

<command> pkiNetworkSign < /command>

<ts>2017-03-22T12:23:11.3820412+05:30 < /ts>

<txn> unique​ ​id < /txn>

<status> failed < /status>

<error​ ​code=””>error message < /error>

< /response>

© Capricorn Identity Services Private Limited 2020.

Follow Us      
Terms of Service |  
Privacy Policy |