Metoda Preserve_register
Umožňuje v kvalifikované službě SecuSign uchovat elektronické podpisy v dokumentu, jež je opatřen uznávaným, kvalifikovaným nebo zaručeným elektronickým podpisem, značkou a/nebo kvalifikovaným elektronickým časovým razítkem. Při registraci je dokument opatřen kvalifikovaným elektronickým časovým razítkem pro jednoznačné určení časového údaje, kdy služba převzala dokument do evidence.
Popis služby včetně WSDL schématu a příklad požadavku a odpovědi pro SOAP 1.1 a SOAP 1.2 je umístěn na https://localhost/secusign/default.asmx?op=Preserve_register.
Localhost je název používaný pro lokální počítač; namísto něj zvolte jméno/IP adresu SDK serveru (dle nastavení v IIS). |
Požadavek v rozhraní SOAP 1.1
POST /secusign/default.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://software602.com/secusign/Preserve_register"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Preserve_register xmlns="http://software602.com/secusign/">
<FileName>string</FileName>
<FileData>base64Binary</FileData>
<FileType>UNKNOWN or CMSPKCS7 or CMSPKCS7Ext or PDF or XML or XML602FORM or XMLISDOC or ASiC_S_CAdES or ASiC_S_XAdES or ASiC_S_Tst or ASiC_E_CAdES_Tst or ASiC_E_XAdES or MS_WORD or MS_EXCEL or MS_PWR_PNT or ODF</FileType>
<ExternalSignatureFileName>string</ExternalSignatureFileName>
<ExternalSignature>base64Binary</ExternalSignature>
<SigValidityCondition>ALL or AT_LEAST_ONE or LAST</SigValidityCondition>
<Properties>
<AddTimeStampIfNeeded>boolean</AddTimeStampIfNeeded>
</Properties>
<SortInfo>string</SortInfo>
<UserComment>string</UserComment>
<Params>string</Params>
</Preserve_register>
</soap:Body>
</soap:Envelope>
Vstupní parametry metody
<FileName>
[povinný element]
Vstup | Popis |
---|---|
String |
Název vstupního souboru (včetně přípony) pro uchování. Příklad: Dokument.pdf. Max. 260 znaků. |
<FileType>
[povinný element]
Vstup | Popis |
---|---|
UNKNOWN |
Neznámý typ dokumentu. |
CMSPKCS7 |
Dokument podepsaný interním CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
CMSPKCS7Ext |
Dokument podepsaný externím CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
PDF dokument. |
|
XML |
XML data. |
XML602FORM |
FO/ZFO formuláře aplikace Software602 Form Filler. |
XMLISDOC |
Podepsaná XML ISDOC data. |
ASiC_S_CAdES |
ASiC-Simple s CAdES podpisem. |
ASiC_S_XAdES |
ASiC-Simple s XAdES podpisem. |
ASiC_S_Tst |
ASiC-Simple s Timestamp. |
ASiC_E_CAdES_Tst |
ASiC-Extended s CAdES podpisem nebo s Timestamp |
ASiC_E_XAdES |
ASiC-Extended s XAdES podpisem. |
MS_WORD |
Dokument aplikace MS Word. |
MS_EXCEL |
Dokument aplikace MS Excel. |
MS_PWR_PNT |
Dokument aplikace MS Powerpoint. |
ODF |
OpenDocumentFormat (OpenOffice). |
<ExternalSignatureFileName>
[nepovinný element]
Vstup | Popis |
---|---|
string |
Název souboru (včetně přípony) externího podpisu. Pouze v případě, že k dokumentu byl takový podpis vytvořen. |
<ExternalSignature>
[nepovinný element]
Vstup | Popis |
---|---|
Base64Binary |
Data externího podpisu kódovaná v Base64. Pouze v případě, že k dokumentu byl takový podpis vytvořen. |
<SigValidityCondition>
[povinný element]
Vstup | Popis |
---|---|
String |
Podmínky platnosti podpisu. Hodnoty:
Ověřitelný znamená platný nebo revokovaný. Není akceptován stav, kdy není možné jednoznačně rozhodnout o stavu certifikátu. |
<Properties>
<AddTimestampIfNeeded>
[nepovinný element]
Vstup | Popis |
---|---|
Boolean |
Pokusí se provést prezervaci nad podepsaným souborem, který je bez razítka (BaseLine-B). Pokud je podpis jinak validní, tak se přidá razítko a dokument se zaeviduje pro uchování. V opačném případě se vrátí chyba, že nebylo možné provést uchování souboru. |
</Properties>
<SortInfo>
[nepovinný element]
Vstup | Popis |
---|---|
String |
Zatřiďovací informace – např. název složky, nebo struktura vnořených složek, ve kterých je dokument u uživatele evidován. Max. 100 znaků. |
Struktura odpovědi na požadavek
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Preserve_registerResponse xmlns="http://software602.com/secusign/">
<Preserve_registerResult>int</Preserve_registerResult>
<OutputData>base64Binary</OutputData>
<PreservationInfo>
<CreationDateTime>dateTime</CreationDateTime>
<docId>string</docId>
<fileName>string</fileName>
<fileSize>long</fileSize>
<sortInfo>string</sortInfo>
<lastUpdate>dateTime</lastUpdate>
<expiration>dateTime</expiration>
<docDataHash>base64Binary</docDataHash>
<docDataHashAlg>string</docDataHashAlg>
<currSignHashAlg>string</currSignHashAlg>
<sigValidityCondition>ALL or AT_LEAST_ONE or LAST</sigValidityCondition>
<sigsPreservationStatus>
<PreservationInfo>
<sid>string</sid>
<sigStatus xsi:nil="true" />
<extendedValidationEndDate>dateTime</extendedValidationEndDate>
<signingCertSubject>string</signingCertSubject>
<bIsDocTimeStamp>boolean</bIsDocTimeStamp>
<procesStatus>string</procesStatus>
</PreservationInfo>
<PreservationInfo>
<sid>string</sid>
<sigStatus xsi:nil="true" />
<extendedValidationEndDate>dateTime</extendedValidationEndDate>
<signingCertSubject>string</signingCertSubject>
<bIsDocTimeStamp>boolean</bIsDocTimeStamp>
<procesStatus>string</procesStatus>
</PreservationInfo>
</sigsPreservationStatus>
<preservationHistory>
<PreservationRecord>
<id>int</id>
<operationTime>dateTime</operationTime>
<operationType>REGISTER or UPDATE or UNREGISTER or UNKNOWN</operationType>
<operationStatus>int</operationStatus>
<operationStatusInfo>string</operationStatusInfo>
<fileName>string</fileName>
<fileSize>long</fileSize>
<hashIn>string</hashIn>
<hashOut>string</hashOut>
<userComment>string</userComment>
</PreservationRecord>
<PreservationRecord>
<id>int</id>
<operationTime>dateTime</operationTime>
<operationType>REGISTER or UPDATE or UNREGISTER or UNKNOWN</operationType>
<operationStatus>int</operationStatus>
<operationStatusInfo>string</operationStatusInfo>
<fileName>string</fileName>
<fileSize>long</fileSize>
<hashIn>string</hashIn>
<hashOut>string</hashOut>
<userComment>string</userComment>
</PreservationRecord>
</preservationHistory>
<docType>string</docType>
</PreservationInfo>
<DocInfo>
<CreationDateTime>dateTime</CreationDateTime>
<FileName>string</FileName>
<FileSize>long</FileSize>
<ExtSigFileName>string</ExtSigFileName>
<ExtSigFileSize>long</ExtSigFileSize>
<PDFVersion>string</PDFVersion>
<PDFNumOfPages>int</PDFNumOfPages>
<docType>string</docType>
<expiration>dateTime</expiration>
<docDataHash>base64Binary</docDataHash>
<docDataHashAlg>string</docDataHashAlg>
<currSignHashAlg>string</currSignHashAlg>
<globalStatus>string</globalStatus>
<validationProperties>
<ValidationTime>dateTime</ValidationTime>
<CustomValidationTime>boolean</CustomValidationTime>
<IgnoreNoPOE>boolean</IgnoreNoPOE>
<UseClaimedTimeIfNoTS>boolean</UseClaimedTimeIfNoTS>
<DontUseGracePeriodForQCerts>boolean</DontUseGracePeriodForQCerts>
</validationProperties>
<sigInfos>
<SigInfo>
<id>unsignedInt</id>
<sid>string</sid>
<DecisiveMoment>dateTime</DecisiveMoment>
<DecisiveMomentSource>string</DecisiveMomentSource>
<sigTimestamps xsi:nil="true" />
<sigType>string</sigType>
<xmlSignedReferences xsi:nil="true" />
<pdfByteRange xsi:nil="true" />
<hasFurtherChanges>boolean</hasFurtherChanges>
<Reason>string</Reason>
<Location>string</Location>
<Contact>string</Contact>
</SigInfo>
<SigInfo>
<id>unsignedInt</id>
<sid>string</sid>
<DecisiveMoment>dateTime</DecisiveMoment>
<DecisiveMomentSource>string</DecisiveMomentSource>
<sigTimestamps xsi:nil="true" />
<sigType>string</sigType>
<xmlSignedReferences xsi:nil="true" />
<pdfByteRange xsi:nil="true" />
<hasFurtherChanges>boolean</hasFurtherChanges>
<Reason>string</Reason>
<Location>string</Location>
<Contact>string</Contact>
</SigInfo>
</sigInfos>
</DocInfo>
<StatusMessage>string</StatusMessage>
</Preserve_registerResponse>
</soap:Body>
</soap:Envelope>
Výstupní parametry metody
<Preserve_registerResult>
Návratová hodnota | Popis |
---|---|
Int |
Výsledek metody Preserve_register (uchování dokumentu). 0 = v pořádku, jinak viz Návratové kódy všech metod a chyba popsaná ve StatusMessage. |
<OutputData>
Návratová hodnota | Popis |
---|---|
Base64Binary |
Data uchovaného dokumentu s elektronickými podpisy kódovaná v Base64. |
<PreservationInfo>
<CreationDateTime>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas, kdy došlo k vytvoření reportu o uchování dokumentu s elektronickými podpisy. |
<docID>
Návratová hodnota | Popis |
---|---|
String |
Jednoznačné identifikační číslo uchovaného dokumentu s elektronickými podpisy. Bylo automaticky vygenerováno při procesu uchování ve službě SecuSign. Pod tímto číslem je možné v metodě Preserve_getInfo zjistit informace o uchovaném dokumentu. Max. 128 znaků. |
<fileName>
Návratová hodnota | Popis |
---|---|
String |
Název uchovaného souboru s elektronickými podpisy. Max. 260 znaků. |
<sortInfo>
Návratová hodnota | Popis |
---|---|
String |
Zatřiďovací informace – např. název složky, nebo struktura vnořených složek, ve kterých je dokument u uživatele evidován. Max. 100 znaků. |
<lastUpdate>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas posledního prodloužení platnosti a ověřitelnosti dokumentu s elektronickými podpisy |
<expiration>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas vypršení ověřitelnosti platnosti celého dokumentu. Po tomto datu nebude možné ověřit platnost certifikátů podpisů / pečetí / razítek a zajistit další ověřitelnost a platnost uchovaného dokumentu. |
<docDataHash>
Návratová hodnota | Popis |
---|---|
Base64Binary |
Hash analyzovaného dokumentu kódovaný v Base64. Algoritmus výpočtu hashe je v následujícím elementu docDataHashAlg. |
<docDataHashAlg>
Návratová hodnota | Popis |
---|---|
String |
Algoritmus výpočtu hashe analyzovaného dokumentu. Ve tvaru například: 2.16.840.1.101.3.4.2.1 |
<currSignHashAlg>
Návratová hodnota | Popis |
---|---|
string |
Algoritmus výpočtu hashe posledního podpisu. Příklad: 2.16.840.1.101.3.4.2.1 |
<sigValidityCondition>
Návratová hodnota | Popis |
---|---|
string |
Zvolené podmínky platnosti podpisu v čase uchování. Hodnoty:
|
<sigsPreservationStatus>
<sid>
Návratová hodnota | Popis |
---|---|
string |
Identifikátor uchovaného podpisu, který k danému dokumentu eviduje služba SecuSign. |
<subindication>
Návratová hodnota | Popis |
---|---|
string |
Podstav ověření podpisu – subindikace. Nabývá hodnot (odpovídajících normě ETSI[2]):
|
</sigStatus>
<extendedValidationEndDate>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas, do kdy byla prodloužena ověřitelnost podpisu. |
<signingCertSubject>
Návratová hodnota | Popis |
---|---|
string |
Identifikace podpisového certifikátu, který byl ošetřen. |
<bISDocTimeStamp>
Návratová hodnota | Popis |
---|---|
boolean |
Určuje, zda podpis je samostatným časovým razítkem. |
<procesStatus>
Návratová hodnota | Popis |
---|---|
string |
Stav ošetření podpisu při uchování. Hodnoty:
|
</PreservationInfo>
</sigsPreservationStatus>
<preservationHistory>
<operationType>
Návratová hodnota | Popis |
---|---|
PreserveOperation |
Typ provedené operace. Hodnoty:
|
<operationStatusInfo>
Návratová hodnota | Popis |
---|---|
string |
Textová zpráva odpovídající stavu provedení operace. |
<docType>
Návratová hodnota | Popis |
---|---|
UNKNOWN |
Neznámý typ dokumentu. |
CMSPKCS7 |
Dokument podepsaný interním CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
CMSPKCS7Ext |
Dokument podepsaný externím CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
Podepsaný PDF dokument. |
|
XML |
Podepsaná XML data. |
XML602FORM |
FO/ZFO formuláře aplikace Software602 Form Filler. |
XMLISDOC |
Podepsaná XML ISDOC data. |
ASiC_S_CAdES |
ASiC-Simple s CAdES podpisem. |
ASiC_S_XAdES |
ASiC-Simple s XAdES podpisem. |
ASiC_S_Tst |
ASiC-Simple s Timestamp. |
ASiC_E_CAdES_Tst |
ASiC-Extended s CAdES podpisem nebo s Timestamp. |
ASiC_E_XAdES |
ASiC-Extended s XAdES podpisem. |
MS_WORD |
Podepsaný dokument aplikace MS Word. |
MS_EXCEL |
Podepsaný dokument aplikace MS Excel. |
MS_PWR_PNT |
Podepsaný dokument aplikace MS Powerpoint. |
ODF |
Podepsaný OpenDocumentFormat (OpenOffice). |
</PreservationInfo>
<DocInfo>
Struktura elementu se vrací pouze v případě, kdy nelze provést registraci vstupního dokumentu.
<CreationDateTime>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas, kdy došlo k vytvoření reportu o uchování |
<FileName>
Návratová hodnota | Popis |
---|---|
string |
Název vstupního souboru (včetně přípony), ze kterého byly ověřeny podpisy. Max. 260 znaků. |
<docType>
Návratová hodnota | Popis |
---|---|
UNKNOWN |
Neznámý typ dokumentu |
CMSPKCS7 |
Dokument podepsaný interním CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
CMSPKCS7Ext |
Dokument podepsaný externím CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
Podepsaný PDF dokument. |
|
XML |
Podepsaná XML data. |
XML602FORM |
FO/ZFO formuláře aplikace Software602 Form Filler. |
XMLISDOC |
Podepsaná XML ISDOC data. |
ASiC_S_CAdES |
ASiC-Simple s CAdES podpisem. |
ASiC_S_XAdES |
ASiC-Simple s XAdES podpisem. |
ASiC_S_Tst |
ASiC-Simple s Timestamp. |
ASiC_E_CAdES_Tst |
ASiC-Extended s CAdES podpisem nebo s Timestamp. |
ASiC_E_XAdES |
ASiC-Extended s XAdES podpisem. |
MS_WORD |
Podepsaný dokument aplikace MS Word. |
MS_EXCEL |
Podepsaný dokument aplikace MS Excel. |
MS_PWR_PNT |
Podepsaný dokument aplikace MS Powerpoint. |
ODF |
Podepsaný OpenDocumentFormat (OpenOffice). |
<expiration>
Návratová hodnota | Popis |
---|---|
DateTime |
Datum a čas vypršení ověřitelnosti celého dokumentu. Po tomto datu nebude možné ověřit platnost podpisových certifikátů a zajistit další ověřitelnost, uchování a platnost dokumentu. |
<docDataHash>
Návratová hodnota | Popis |
---|---|
Base64Binary |
Hash analyzovaného dokumentu v kódování Base64. Algoritmus výpočtu hashe je v následujícím elementu docDataHashAlg. |
<docDataHashAlg>
Návratová hodnota | Popis |
---|---|
String |
Algoritmus výpočtu hashe analyzovaného dokumentu. Ve tvaru například: 2.16.840.1.101.3.4.2.1. |
<currSignHashAlg>
Návratová hodnota | Popis |
---|---|
String |
Algoritmus výpočtu hashe posledního podpisu. Příklad: 2.16.840.1.101.3.4.2.1 |
<globalStatus>
Návratová hodnota | Popis |
---|---|
String |
Sumarizuje stav dokumentu na základě všech podpisů a časových razítek. Může nabývat hodnot:
|
<sigInfos>
<SigInfo>
Informace o podpisu (opakující se element v případě více podpisů).
<status>
Návratová hodnota | Popis |
---|---|
String |
Výsledný stav ověření podpisu podle první verze ETSI normy[1] týkající se ověřování PAdES, CAdES, XAdES a ASiC. |
<statusEN>
Návratová hodnota | Popis |
---|---|
String |
Výsledný stav ověření podpisu podle aktuální verze ETSI normy[2] týkající se ověřování PAdES, CAdES, XAdES a ASiC, viz hodnoty Indication a subIndication v Preserve_register/update/getInfo |
<message>
Návratová hodnota | Popis |
---|---|
string |
Podrobnosti ověření stavu podpisu/pečeti/razítka, pokud jsou u daného stavu k dispozici. |
<certType>
Návratová hodnota | Popis |
---|---|
string |
Typ certifikátu podpisu/pečeti/razítka. Může nabývat hodnot:
|
<adesType>
Návratová hodnota | Popis |
---|---|
string |
Typ podpisového certifikátu dle standardu AdES (Advanced Electronic Signature). |
<eidasType>
Návratová hodnota | Popis |
---|---|
string |
Typ podpisového certifikátu dle nařízení eIDAS. Může nabývat hodnot:
|
<baselineType>
Návratová hodnota | Popis |
---|---|
string |
Typ podpisového certifikátu dle Baseline profilu. Může nabývat hodnot:
|
<Subject>
Návratová hodnota | Popis |
---|---|
string |
Informace z certifikátového atributu Subjekt, např.:
|
<Issuer>
Návratová hodnota | Popis |
---|---|
string |
Kompletní informace o vystaviteli certifikátu z atributu Issuer. |
<string>
Návratová hodnota | Popis |
---|---|
string |
Prohlášení vystavitele kvalifikovaného certifikátu ve formě OID. |
</qcStatements>
<qcType>
Návratová hodnota | Popis |
---|---|
string |
Typ certifikátu podpisu/pečeti/razítka dle eIDAS, pouze u CertType QUALIFIED a LEGACY. |
<signCertIsPseudonyme>
Návratová hodnota | Popis |
---|---|
boolean |
Určuje, zda je certifikát (podpisu/pečeti/razítka) vystaven na pseudonym. |
<certPath>
<Subject>
Návratová hodnota | Popis |
---|---|
string |
Informace z atributu certifikátu Subjekt, např.
|
<Issuer>
Návratová hodnota | Popis |
---|---|
string |
Kompletní informace o vystaviteli certifikátu z atributu Issuer. |
<ServiceStatusUri>
Návratová hodnota | Popis |
---|---|
String |
Obsahuje celou Uri stanovující servisní stav certifikátu na TSL, např. http://uri.etsi.org/TrstSvc/TrustedList/Svcstatus/granted. |
<ServiceTypeUri>
Návratová hodnota | Popis |
---|---|
String |
Obsahuje celou Uri stanovující servisní typ certifikátu na TSL, např. http://uri.etsi.org/TrstSvc/Svctype/CA/QC. |
<crlPath>
<Data>
Návratová hodnota | Popis |
---|---|
string |
Revokační data CRL v base64 na základě kterých se ověřovala platnost podpisu/pečeti/razítka. |
<Source>
Návratová hodnota | Popis |
---|---|
string |
Zdroj revokačních dat, nabývá hodnot:
|
<DistributionPointChecked>
Návratová hodnota | Popis |
---|---|
boolean |
Informace, zda byl kontrolován distribuční bod CRL. Není vždy potřebné. |
<DistributionPointCheckDate>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas kontroly distribučního bodu. |
<DistributionPointThisUpdate>
Návratová hodnota | Popis |
---|---|
dateTime |
Informace z distribučního bodu CRL o datu a času vydání této aktualizace. Pokud CRL pro časové razítko byl vydán před rozhodným okamžikem, hledá se novější na DistributionPoint a pokud není k dispozici novější, nebyl v DistributionCheckDate certifikát časového razítka revokován. |
<lastHashAlgOid>
Návratová hodnota | Popis |
---|---|
dateTime |
Jedná se o poslední použitý OID digest algoritmus v SignerInfo (CMS, PDF). Příklad pro SHA256 algoritmus: 2.16.840.1.101.3.4.2.1. |
<id>
Návratová hodnota | Popis |
---|---|
unsignedInt |
Pořadové číslo podpisu tak, jak byl přidán do dokumentu. Počítáno od nuly. |
<DecisiveMoment>
Návratová hodnota | Popis |
---|---|
dateTime |
Rozhodný okamžik je čas, ke kterému rozhodujeme o dané entitě (podpisu/razítku). Jedná se vlastně o Proof of Existence, ke kterému entitu ověřujeme. Pokud není k dispozici datum a čas časového razítka použije se ValidationTime (případně aktuální datum). |
<DecisiveMomentSource>
Návratová hodnota | Popis |
---|---|
string |
Informace o původu času rozhodného okamžiku pro vyhodnocení podpisu. Hodnoty:
|
<sigTimestamps>
Nepovinný element, je závislý na existenci časového razítka u podpisu.
Návratová hodnota | Popis |
---|---|
XML struktura |
Informace o časovém razítku přidaném jako atribut k digitálnímu podpisu. Stejná XML struktura informací jako u nadřazeného podpisu. Tedy obsahuje element SigInfo, viz výše, včetně všech jeho potomků. Informace v potomcích se váží k certifikátu časového razítka. |
<sigType>
Návratová hodnota | Popis |
---|---|
enum |
Typ podpisu. Může nabývat hodnot:
|
<xmlSignedReferences>
Nepovinný element, je závislý na formátu vstupního souboru (jen pro XML/ZFO)
Návratová hodnota | Popis |
---|---|
XML struktura |
Data podpisu. |
<pdfByteRange>
Nepovinný element, je závislý na formátu vstupního souboru (jen pro PDF)
Návratová hodnota | Popis |
---|---|
XML struktura |
Bytový rozsah PDF podpisů. |