Microsec XSign4COM fejlesztői leírás

LONG Initialize(BSTR workDir, BSTR regFilePath, BSTR sdkPassword);

Az XSign4COM modult használat előtt inicializálni kell ezen függvény segítségével. A bemeneti paraméterben megadott könyvtárba ideiglenes fájlokat fog elhelyezni a program, ezért oda írási jogosultságának kell lennie. Az inicializálást a IXSignSession::SetLogFilePath() függvény hívása megelőzheti, ilyenkor már az inicializálás is naplózásra kerül.

Paraméterek:

• BSTR workDir – Bemeneti paraméter. A munkakönyvtárat adja meg.
• BSTR regFilePath – Bemeneti paraméter. A modulhoz tartozó regisztrációs fájlt kell megadni, részletek a Regisztráció című fejezetben találhatók.
• BSTR sdkPassword – Az SDK használatához szükséges jelszó (kód), amennyiben a regisztráció típusa megköveteli.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG Finalize();

A futás végeztével meg kell hívni a XS_Finalize függvényt, hogy a modul a lefoglalt memóriaterületeket felszabadítsa. Az XS_Finalize hatására érvénytelenné válnak a korábban példányosított, ezen session keretein belül létrehozott objektumok.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch * NewDossier();

Új e-aktát hoz létre. A korábban létrehozott e-aktákat nem érinti az új e-akta létrehozása; azaz több e-aktán is lehet párhuzamosan dolgozni. Az e-aktához tartozó környezet is inicializálódik a függvény meghívásával, így például külön URL cache jön léte minden új e-aktához.

Visszatérési érték:

Egy új IXSignDossier interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az e-aktához tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * OpenDossier(BSTR dossierPath);

Fájlrendszerből nyithatunk meg e-aktát a függvény segítségével.

Paraméter:

• BSTR dossierPath – Bemeneti paraméter. A megnyitni kívánt e-akta elérési útja.

Visszatérési érték:

Egy új IXSignDossier interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az e-aktához tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

LONG GetLastError();

Az utolsó művelet sikerességéről szóló információt (XSign hibakódot, lásd az XSign visszatérési értékek című alfejezetet) kérhetjük le.

Visszatérési érték:

Az XSign legutóbbi visszatérési értéke (lásd XSign visszatérési értékek című alfejezet).

LONG SetTimeStampURLs(BSTR timeStampURLs);

A paraméter az időbélyeg szolgáltatók URL listáját állítja be. Időbélyeges aláírás és különálló időbélyeg készítésekor is ebből a listából választ az alkalmazás, hogy melyik szolgáltatóhoz forduljon időbélyegért. A lista első elemével próbálkozik először, amennyiben ez nem sikerül erről a címről időbélyeget kérni, megpróbálkozik a következő hellyel és így tovább. A timeStampURLs paraméterben, szóközzel elválasztott karakterlánc formájában kell a listát megadni.

Paraméter:

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetXAdESType(LONG xadesType);

Az aláíráskor használandó a XAdES szabványnak megfelelő aláírás típusokat tudjuk kiválasztani. Az aláírás típusának beállítása mellett gondoskodni kell a többi paraméter beállításáról is, hogy az adott aláírás típus létre tudjon jönni. Például a XAdES-T aláíráshoz be kell állítani az időbélyeg szolgáltató URL-t és a hozzáférési információkat.

Paraméter:

• LONG xadesType– Bemeneti paraméter. Aláírás típusa; a következő értékeket veheti föl:
  • 1 - XS_XADES_BES alap aláírás
  • 2 - XS_XADES_EPES alap aláírás aláírási szabályzattal
  • 3 - XS_XADES_T időbélyeges aláírás
  • 7 - XS_XADES_A teljes aláírás védelme archív időbélyeggel

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

Megjegyzés:

Ha ETSI EN 319 * szabványok alapján szeretne aláírást készíteni, akkor a setSignatureLevel metódust használja.

LONG SetSignatureLevel(LONG sigLevel);

Az aláíráskor használandó AdES baseline vagy extended profilnak megfelelő aláírás típusokat tudjuk kiválasztani. Az aláírás típus beállítása mellett gondoskodni kell a többi paraméter beállításáról is, hogy az adott aláírás típus létre tudjon jönni. Például B_T aláíráshoz be kell állítani az időbéyleg szolgáltató URL-t és a hozzáférési információkat.

Paraméter:

• LONG sigLevel– Bemeneti paraméter. Aláírás típusa; a következő értékeket veheti fel:
  • 1 - XS_SIGLEVEL_B_B alap aláírás (baseline)
  • 2 - XS_SIGLEVEL_B_T időbélyeges aláírás (baseline)
  • 3 - XS_SIGLEVEL_B_LT long-term típusú időbélyeges aláírás (baseline)
  • 4 - XS_SIGLEVEL_B_LTA archív aláírás (baseline)
  • 5 - XS_SIGLEVEL_E_BES alap aláírás (extended)
  • 6 - XS_SIGLEVEL_E_EPES alap aláírás (extended)
  • 7 - XS_SIGLEVEL_E_T időbélyeges aláírás (extended)
  • 8 - XS_SIGLEVEL_E_A archív aláírás (extended)

Visszatérési értékek:

Az XSign visszattérési értéke (lásd 4. alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetDefaultTSAuthCert(LONG refType, BSTR reference);

Ha az időbélyeg szolgáltató tanúsítvány alapú autentikációt követel meg, akkor ezen függvény segítségével állíthatjuk be az alapértelmezetten használni kívánt autentikációs tanúsítványt.

Paraméterek:

• LONG refType – Bemeneti paraméter. Értéke határozza meg a reference változó típusát. Lehetséges értéke:
  • 0 – a referencia értéke a tanúsítvány SHA1 lenyomatát (20 bájt) tartalmazza hexadecimális formában, bájtonként szóközzel elválasztva (pl. „a0 61 89 a6 66 85 61 5c 75 30 66 c1 e7 5e bd e4 3e 1b d7 6a”).
• BSTR reference – Bemeneti paraméter. A tanúsítvány kiválasztásához használandó adat, típusát a refType paraméter határozza meg.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetDefaultOCSPAuthCert(LONG refType, BSTR reference);

Ha az OCSP szolgáltató tanúsítvány alapú autentikációt követel meg, akkor ezen függvény segítségével állíthatjuk be az alapértelmezetten használni kívánt autentikációs tanúsítványt.

Paraméterek:

• LONG refType – Bemeneti paraméter. Értéke határozza meg a reference változó típusát. Lehetséges értéke:
  • 0 – a referencia értéke a tanúsítvány SHA1 lenyomatát (20 bájt) tartalmazza hexadecimális formában, bájtonként szóközzel elválasztva (pl. „a0 61 89 a6 66 85 61 5c 75 30 66 c1 e7 5e bd e4 3e 1b d7 6a”).
• BSTR reference – Bemeneti paraméter. A tanúsítvány kiválasztásához használandó adat, típusát a refType paraméter határozza meg.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetLogFilePath(BSTR logFilePath);

Naplófájlt állíthatunk be a metódus segítségével. A modul működése közben a naplófájlba írja a működéssel kapcsolatos információkat, ha meg van adva naplófájl. Ha egy külön szálban hívjuk meg a metódust, akkor az adott szálhoz egy külön naplófájl nyílik meg a paraméterben megadott elérési úton. Ha ugyanabban a szálban másodszor hívjuk, akkor az előző naplófájl lezáródik, és az új megnyílik. Ha a logFilePath üres string, akkor visszaáll az alapértelemezett naplózás. A metódus meghívása automatikusan Debug (4) szintre állítja a naplózást.

Paraméter:

• BSTR logFilePath – Bemeneti paraméter. A naplófájl elérési útját tartalmazó string.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetLogFileMaxSize(LONG maxSizeInKB);

E függvény segítségével megadhatjuk a SetLogFilePath által beállított naplófájl maximális méretét, kilobájt mértékegységben. Ha nincs naplófájl beállítva, akkor a metódus XSR_INVALID_OPERATION (0x12) hibával tér vissza. Mielőtt a naplófájl elérné a megadott méretet, elmozgatásra kerül egy tartalék (backup) naplófájlba, melynek elérési útja a következő módon képződik: „.1” (pl.: c:/path/to/file.txt esetén a backup naplófájl a c:/path/to/file.1.txt lesz). Amennyiben nullát adunk meg maximális méretként, kikapcsolódik a méret ellenőrzése.

Paraméter:

• LONG maxSizeInKB – Bemeneti Paraméter: a naplófájl maximális mérete kilobájtban. Nulla megadása esetén kikapcsolódik a naplófájl méretének ellenőrzése.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG CloseLogFilePath();

Korábban az SetLogFilePath() függvénnyel megnyitott naplófájl zárható le. A metódus meghívásakor mindent kiír a naplófájlba majd lezárja azt.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetLogFilePathAndLogLevel(BSTR logFilePath, LONG logLevel);

A metódus segítségével megadhatjuk, hogy a futás során készítsen-e a program naplófájlt.

Paraméterek:

• BSTR logFilePath – A létrehozandó naplófájl neve és elérési útja.
• LONG logLevel – A naplózás szintjét adja meg. Lehetséges értékei:
  • 0 - Nem keletkezik napló fájl.
  • 1 - Error és annál magasabb szintű üzenetek íródnak a naplóba.
  • 2 - Warn és annál magasabb szintű üzenetek íródnak a naplóba.
  • 3 - Info szintű üzenetek íródnak a naplóba.
  • 4 - Debug és annál magasabb szintű üzenetek íródnak a naplóba.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetWorkSilent(LONG howSilent);

A modul működése közben dialógus ablakok segítségével, státusz üzenetekkel értesíti a felhasználót bizonyos eseményekről. Ezen függvény segítségével kikapcsolhatjuk a felugró ablakokat.

Paraméter:

• LONG howSilent – Bemeneti paraméter. A felhasználói kommunikáció mértékét állíthatjuk be. Lehetséges értékei:
  • 0 - XS_NON_SILENT Minden üzenet megjelenik.
  • 1 - XS_SILENT Az üzenetek nem jelennek meg a képernyőn, kivéve, ha valamely szükséges beállítás (pl. aláírói vagy autentikációs tanúsítvány, HTTP kapcsolódási jelszó) hiánya miatt a művelet végrehajtása sikertelen lenne – ezen esetben a megfelelő kiválasztó ablak megjelenik.
  • 2 - XS_FORCE_SILENT Semmilyen ablakot és üzenetet nem küld a modul, akkor sem, ha emiatt meghiúsul a művelet végrehajtása.
  • 3 - XS_SILENT_WITH_STATUS A működése megegyezik az XS_SILENT opció működésével, azzal a kiegészítéssel, hogy status üzeneteket küld a modul. A status üzeneteket események formájában küldi. Az esemény leírásáról az _IXSignEvents interfész leírásánál olvashat részletesen.
  • 4 - XS_FORCE_SILENT_WITH_STATUS A működése megegyezik az XS_FORCE_SILENT opció működésével, azzal a kiegészítéssel, hogy status üzeneteket küld a modul. A status üzeneteket események formájában küldi. Az esemény leírásáról az _IXSignEvents interfész leírásánál olvashat részletesen.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetRevocationCheckingMode(LONG revCheckMode);

A visszavonás-ellenőrzés módját lehet beállítani. A beállított érték vonatkozik az aláíráskori és az ellenőrzéskori visszavonás-ellenőrzésre is. A beállított érték befolyásolhatja az elkészült aláírás típusát, például kikapcsolt visszavonás-ellenőrzés esetén nem lehet archív aláírást létrehozni. Amennyiben az ellenőrizendő aláírás már tartalmaz magában csatolt visszavonási információkat, akkor az alkalmazás azok alapján ellenőriz, ha az egyezik a beállított visszavonási móddal. Azaz, ha például az archív aláírás OCSP válaszokat tartalmaz magában, és a visszavonás ellenőrzés is OCSP-re van állítva, akkor a tárolt válasz alapján ellenőriz az alkalmazás. Az archív aláírás ellenőrzése függetlenül ettől a beállítástól kikapcsolható.

Paraméter:

• LONG revCheckMode – Bemeneti paraméter. A visszavonás-ellenőrzés típusát állíthatjuk be. Lehetséges értékei:
  • 0 - XS_REV_CHECK_OFF A visszavonás-ellenőrzés teljesen ki van kapcsolva.
  • 1 - XS_REV_CHECK_CRL A visszavonás-ellenőrzés CRL alapján történik.
  • 2 - XS_REV_CHECK_OCSP A visszavonás-ellenőrzés OSCP alapján történik.
  • 3 - XS_REV_CHECK_OCSP_CRL A visszavonás-ellenőrzést először OCSP alapján próbálja meg elintézni az alkalmazás, amennyiben ez nem volt sikeres CRL alapján próbál visszavonást ellenőrizni.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetDefaultSigningCert(LONG refType, BSTR reference);

Előre beállíthatunk egy alapértelmezett aláírói tanúsítványt, amelyet aláírásra szeretnénk használni, ilyenkor a modul nem kéri be minden aláírás előtt a tanúsítványt, hanem az előre beállítottat használja.

Paraméterek:

• LONG refType – Bemeneti paraméter. Értéke határozza meg a reference változó típusát. Lehetséges értéke:
  • 0 – a referencia értéke a tanúsítvány SHA1 lenyomatát (20 bájt) tartalmazza hexadecimális formában, bájtonként szóközzel elválasztva (pl. „a0 61 89 a6 66 85 61 5c 75 30 66 c1 e7 5e bd e4 3e 1b d7 6a”).
• BSTR reference – Bemeneti paraméter. A tanúsítvány kiválasztásához használandó adat, típusát a refType paraméter határozza meg.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch * NewForeignDossier([in, defaultvalue("")] BSTR xmlSource);

Különálló aláírás létrehozására alkalmas dossziét nyithatunk a metódus segítségével. Továbbá már létező XML állományt is megnyithatunk aláírás céljából.

Paraméter:

• BSTR xmlSource – Bemeneti paraméter. Az aláírni kívánt nem e-akta formátumú XML állományt kell megadni string formátumban. Alapértelmezett értéke az üres string. Ilyenkor egy üres dosszié jön létre.

Visszatérési érték:

Egy új IXSignForeignDossier interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dossziéhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * OpenForeignDossier([in] BSTR dossierPath);

Korábban létrehozott különálló aláírást, vagy nem e-akta típusú aláírt XML állományt tudunk megnyitni a metódus segítségével. Az ilyen típusú dokumentumok tartalma csak olvasható.

Paraméter:

• BSTR dossierPath – Bemeneti paraméter. A megnyitandó nem e-akta formátumú XML állomány elérési útját kell megadni string formátumban. Nincs alapértelmezett értéke.

Visszatérési érték:

Egy új IXSignForeignDossier interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dossziéhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * CreateAcknowledgement(BSTR filePath);

Egy megadott aktáról átvételi elismervény készíthető. Az átvételi elismervényre készülő aláírás beállításai megegyeznek az aláírás beállításokkal.

Megjegyzés:

Windows CE operációs rendszer alatt nem támogatott ez a funkció.

Paraméter:

• BSTR filePath – Bemeneti paraméter. Azon elektronikus akta elérési útja, melyről átvételi elismervényt szeretnénk generálni.

Visszatérési érték:

Egy új IXSignDossier interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dossziéhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * CreateAcknowledgement(BSTR filePath, BSTR fileHash);

Egy megadott aktáról átvételi elismervény készíthető. Az átvételi elismervényre készülő aláírás beállításai megegyeznek az aláírás beállításokkal.

Megjegyzés:

Windows CE operációs rendszer alatt nem támogatott ez a funkció.

Paraméterek:

• BSTR filePath – Bemeneti paraméter. Azon elektronikus akta elérési útja, melyről átvételi elismervényt szeretnénk generálni.
• BSTR fileHash – Bemeneti paraméter. Azon elektonikus akta sha256 lenyomata amelyre az átvételi elismervényt készítjük. Amennyiben megadásra kerül, az átvételi elismervényt ezen lenyomat alapján készíti, nem a filePath paraméterben beállított fájlról.

Visszatérési érték:

Egy új IXSignDossier interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dossziéhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

LONG SetDefaultBasicAuth(BSTR login, BSTR password);

Beállíthatjuk az e-szigno.hu domainhez tartozó alapértelmezett időbélyeg szolgáltató és az OCSP szolgáltató felhasználónév-jelszó párost. Ha valamely szerver basic autentikációt kér a modultól, akkor ezt a beállított felhasználó nevet és jelszót fogja adni válaszként. Ez a függvény csak e-szigno.hu domain esetén állítja be az adatokat, más domain-hez a SetBasicAuth függvény használata szükséges.

Paraméterek:

• BSTR login – Bemeneti paraméter. Login (felhasználó-) név.
• BSTR password – Bemeneti paraméter. Jelszó.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetSigningCertificate([in] LONG inputType, [in] BSTR inputStr);

Elosztott (kétmenetes) aláírás esetén beállíthatjuk az aláíráshoz használt kulcshoz tartozó tanúsítványt. Az elosztott aláírásról részletesebb leírást a IXSignDossier::SetSignedHash() metódusnál találhat.

Paraméterek:

• LONG inputType – Bemeneti paraméter. Az inputStr paraméterben megadandó érték típusát határozza meg. Lehetséges értékei:
  • 0 – a tanúsítványt tartalmazó fájl elérési útját kell megadni az inputStr paraméterben.
• BSTR inputStr – Bemeneti paraméter. A tanúsítvány kiválasztásához használni kívánt azonosító adatot kell megadni.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG Register([in] BSTR regKey, [in] BSTR outFilePath, [in, defaultvalue("")] BSTR regURL);

A regisztrált működéshez szükséges regisztrációs fájt kérhetünk le a regisztrációs szervertől egy regisztrációs kulcs segítségével.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Paraméterek:

• BSTR regKey – Bemeneti paraméter. A regisztrációs kulcs. Ezt a regisztrációs kulcsot a Microsec zrt. bocsájtja rendelkezésre, amennyiben a modult megvásárolják.
• BSTR outFilePath – Bemeneti paraméter. Sikeres művelet esetén a modul erre a megadott elérési útra teszi le az aláírt regisztrációs fájlt.
• BSTR regURL – Bemeneti paraméter. A regisztrációs szerver URLje. Alapértelmezett értéke az üres string, ekkor a https://srv.e-szigno.hu/cgi-bin/registration.cgi. című regisztrációs szerverhez kapcsolódik a modul.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetTimeout([in] LONG timeOut);

A hálózati kapcsolódást igénylő műveletek a beállított timeout után megszakadnak. LDAP kapcsolódás esetén fixen 15 másodperc a timeout függetlenül a függvény által beállított értéktől.

Paraméterek:

• LONG timeOut – Bemeneti paraméter. Az időtartam, amennyi után a kapcsolat megszakad. Értékét ms-ban kell megadni.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetRetryCount([in] LONG retryCount);

Bizonyos sikertelen HTTP kapcsolódások esetén (ha nem kap semmilyen választ, 503-as hiba, illetve TRYLATER OCSP válasz esetén) hányszor próbáljon meg újra csatlakozni. Alapértelmezetten nullára van állítva.

Paraméterek:

• LONG retryCount – Bemeneti paraméter. Ennyiszer próbál meg újra csatlakozni.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetRetryDelay([in] LONG retryDelay);

Ha az SetRetryCount be van állitva, akkor ezen metódussal állíthatjuk be, hogy mennyi milliszekundumot várjon az újrapróbálkozások között. Alapértelmezetten nullára van állítva.

Paraméterek:

• LONG retryDelay – Bemeneti paraméter. Az idő, milliszekundumban, amennyit vár az újrapróbálkozások között.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetRecipientCertList([in] BSTR certList)

A titkosítás címzettjeinek a tanúsítványait állíthatjuk be a függvény segítségével.

Paraméter:

• BSTR certList – Bemeneti paraméter. A titkosító tanúsítványok elérési útjait tartalmazó lista. A listát „;” karakterrel kell elválasztani.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetEncryptingKey([in] BSTR path, [in] BSTR password)

A titkosított akta vagy dokumentum megtekintésére használandó titkosító kulcsot lehet beállítani. A beállított kulcshoz tartozó tanúsítvány bekerül a címzettek közé az IXSignDossier::Encrypt() és az IXSignDocument::Encrypt() függvények használata esetén (titkosításkor).

Paraméterek:

• BSTR path – Bemeneti paraméter. A PFX fájl elérési útja.
• BSTR password – Bemeneti paraméter. A PFX fájlhoz tartozó jelszó.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetEncryptingKeyPKCS11([in] BSTR pkcs11ModulePath, [in] LONG keyRefType, [in] BSTR keyRefValue, [in] BSTR pass)

A titkosított akta vagy dokumentum megtekintésére használandó titkosító kulcsot lehet beállítani. A kulcs PKCS#11-es függvénykönyvtáron keresztül érhető el. A beállított kulcshoz tartozó tanúsítvány bekerül a címzettek közé az IXSignDossier::Encrypt() és az IXSignDocument::Encrypt() függvények használata esetén (titkosításkor).

Paraméterek:

• BSTR pkcs11ModulePath – A PKCS#11-es függvénykönyvtár elérési útja.
• LONG keyRefType – Bemeneti paraméter. Értéke határozza meg a keyRefValue változó típusát. Lehetséges értékei:
  • 1 – tanúsítvány CN;
  • 2 – tanúsítvány SHA-1 lenyomat.
• BSTR keyRefValue – Bemeneti paraméter. A tanúsítvány kiválasztásához használandó adat, típusát a keyRefType paraméter határozza meg.
• BSTR pass – A kulcshoz tartozó PIN kód.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetEncryptingKeyPKCS11v2([in] BSTR pkcs11ModulePath, [in] LONG keyRefType, [in] BSTR keyRefValue, [in] BSTR sUserPIN, [in] BSTR sContextSpecificPIN)

A titkosított akta vagy dokumentum megtekintésére használandó titkosító kulcsot lehet beállítani. A kulcs PKCS#11-es függvénykönyvtáron keresztül érhető el. A beállított kulcshoz tartozó tanúsítvány bekerül a címzettek közé az IXSignDossier::Encrypt() és az IXSignDocument::Encrypt() függvények használata esetén (titkosításkor).

Paraméterek:

• BSTR pkcs11ModulePath – A PKCS#11-es függvénykönyvtár elérési útja.
• LONG keyRefType – Bemeneti paraméter. Értéke határozza meg a keyRefValue változó típusát.
  • Lehetséges értékei: 1 – tanúsítvány CN;
  • 2 – tanúsítvány SHA-1 lenyomat.
• BSTR keyRefValue – Bemeneti paraméter. A tanúsítvány kiválasztásához használandó adat, típusát a keyRefType paraméter határozza meg.
• BSTR sUserPIN – A PKCS#11-es token felhasználói PIN kódja. Olyankor kell megadni, ha a tokennel olyan kriptográfiai műveletet (aláírás vagy kititkosítás) szeretnénk végrehajtani, ami hitelesítést igényel. (További információért olvassa el a PKCS#11: Cryptographic Token Interface Standard Version 2.20).
• BSTR sContextSpecificPIN – A PKCS#11-es token környezet specifikus PIN kódja. Olyankor kell megadni, ha egy kulcs minden használat (aláírás vagy kititkosítás) előtt hitelesítést igényel. (További információért olvassa el a PKCS#11: Cryptographic Token Interface Standard Version 2.20)

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG UseAIAForOCSP([in] VARIANT_BOOL useIt);

Ezen opció segítségével beállíthatjuk, hogy a tanúsítványban található AIA URL-t használja-e a modul az OCSP szolgáltatás eléréséhez.

Paraméter:

• VARIANT_BOOL useIt – Bemeneti paraméter. Amennyiben értéke VARIANT_TRUE, akkor a tanúsítványban található URL-t használja az alkalmazás. VARIANT_FALSE érték esetén a korábban az SetOCSPURLList() (ld. később) metódus által beállított URL-eket fogja használni a modul OCSP kéréshez.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG WaitForGracePeriod(VARIANT_BOOL wait);

Amennyiben ezen opció értéke „VARIANT_TRUE”, akkor az e-Szignó csak az aláírás (megbízható) időpontja után kibocsátott CRL-eket vagy OCSP válaszokat fogadja el. Alapértelmezett értéke „VARIANT_TRUE”. Javasoljuk, hogy OCSP alapú visszavonás-ellenőrzés esetén használja a „VARIANT_TRUE” beállítást.

Paraméterek:

• VARIANT_BOOL wait – Bemeneti paraméter. Amennyiben értéke „VT_TRUE”, az e-Szignó csak az aláírás időpontja után kibocsátott CRL-eket vagy OCSP válaszokat fogadja el.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetCRLURLList([in] BSTR crlURLList);

A felhasználandó CRL szolgáltatók listáját lehet megadni ezen opció segítségével. Általában akkor van szükség e beállításra, ha az ellenőrizendő tanúsítványok nem tartalmazzák a rájuk érvényes CRL szolgáltató URL-jét az AIA kiterjesztésben.

Megjegyzés:

Paraméter:

• BSTR crlURLList – Bemeneti paraméter. Szóközzel elválasztott karakterlánc formájában kell a listát megadni, a következő formában: „http://pl1.hu http://pl2.hu http://pl3.hu”.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetOCSPURLList([in] BSTR ocspURLList);

A felhasználandó OCSP szolgáltatók listáját lehet megadni ezen opció segítségével. Általában akkor van szükség e beállításra, ha az ellenőrizendő tanúsítványok nem tartalmazzák a rájuk érvényes OCSP szolgáltató URL-jét az AIA kiterjesztésben.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez az opció.

Paraméter:

• BSTR ocspURLList – Bemeneti paraméter. Szóközzel elválasztott karakterlánc formájában kell a listát megadni, a következő formában: „http://pl1.hu http://pl2.hu http://pl3.hu”.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SignPDF([in] BSTR inputPDFPath, [in] BSTR outputPDFPath);

PDF fájlokat nem csak e-aktán belül lehet aláírni, hanem közvetlenül a fájlt is aláírhatjuk, hiszen a PDF szabvány (az 1.3 verzió óta) ezt megengedi. Ennek a tagfüggvénynek a segítségével tudunk közvetlenül, e-akta létrehozás nélkül PDF aláírást létrehozni. Amennyiben a visszavonás-ellenőrzési mód nincs megadva, alapértelmezetten OCSP/CRL-re állítódik.

Paraméterek:

• BSTR inputPDFPath – Bemeneti paraméter. Az aláírni kívánt PDF fájl elérési útját adhatjuk meg.
• BSTR outputPDFPath – Bemeneti paraméter. A modul az aláírt PDF fájlt az itt megadott elérési útra menti.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetCustomNamespace([in] BSTR customNamespace, [in] BSTR customSchemaLocation);

Az e-aktának egyedi névteret lehet beállítani a paraméter segítségével. Ezen függvény segítségével hozhatunk létre az e-Szignó kliens alkalmazásban látható ügyviteli sémákhoz hasonló aktákat.

Paraméterek:

• BSTR customNamespace – Bemeneti paraméter. A névteret tartalmazó karakterláncot adhatjuk meg.
• BSTR customSchemaLocation – Bemeneti paraméter. Az XML séma elérését lehet megadni.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch * OpenPDF([in] BSTR path, [in] VARIANT_BOOL validatePDF);

Megnyit egy PDF dokumentumot és visszaadja az új PDF dokumentum objektumra hivatkozó IXSignPDFDocument interfész mutatót.

Paraméter:

• BSTR path - Bemeneti paraméter. A megnyitandó PDF dokumentum elérési útja.
• VARIANT_BOOL validatePDF - Bemeneti paraméter. A paraméter megmondja, hogy megnyitáskor az alkalmazás ellenőrizze-e a teljes pdf formázottságát. FALSE esetén nem tölti be a teljes pdf dokumentumot a memóriába.

Visszatérési érték:

Egy új IXSignPDFDocument interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dossziéhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * OpenEncryptedPDF([in] BSTR path, [in] BSTR password, [in] VARIANT_BOOL validatePDF);

Megnyit egy titkosított PDF dokumentumot és visszaadja az új PDF dokumentum objektumra hivatkozó IXSignPDFDocument interfész mutatót.

Paraméter:

• BSTR path - Bemeneti paraméter. A megnyitandó PDF dokumentum elérési útja.
• BSTR password - Bemeneti paraméter. Jelszó a titkosított PDF kezeléséhez.
• VARIANT_BOOL validatePDF - Bemeneti paraméter. A paraméter megmondja, hogy megnyitáskor az alkalmazás ellenőrizze-e a teljes pdf formázottságát. FALSE esetén nem tölti be a teljes pdf dokumentumot a memóriába.

Visszatérési érték:

Egy új IXSignPDFDocument interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dossziéhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

LONG ValidateOCSPResponder([in] VARIANT_BOOL validateOCSPResponder);

Ezen metódus segítségével beállíthatjuk, hogy az e-Szignó ellenőrizze-e az OCSP válaszadó visszavonási állapotát.

Paraméter:

• VARIANT_BOOL validateOCSPResponder - Bemeneti paraméter. Amennyiben értéke VARIANT_TRUE, az OCSP válaszadók visszavonási állapota ellenőrzésre kerül.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetXAdESVersion([in] BSTR ver);

Ezen metódus az aláírás létrehozása során használt XAdES szabvány verzióját állítja be.

Paraméter:

• BSTR ver - Bemeneti paraméter. A paraméterben következő értékek szerepelhetnek:
  • "1.2.2" (verzió: 1.2.2)
  • "1.3.2" (verzió: 1.3.2).
  • "1.4.2" (verzió: 1.4.2).
  • "EN-1.0.0" (verzió: EN-1.0.0).
  Az alapértelmezett beállítás az 1.4.2-es szabvány.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

Megjegyzés:

Signature level használata esetén kötelező minimum a EN-1.0.0 verzió használata, mivel ez a szabvány tartalmazza a signature level szinteket.

LONG SetPDFSignImg([in] BSTR path);

Látható PDF aláírás létrehozásakor megadható kép fájl elérési útja, amelyet elhelyezhetünk a PDF dokumentum törzsében. A megadott képfájlnak a következő kép formátumok egyikének kell megfelelnie: png,jpg,tif.

Paraméter:

• BSTR path - Elérési út.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgPage([in] LONG pageno);

Megadható, hogy a látható PDF aláírást melyik oldalán helyezzük el a dokumentumnak. Alapértelmezett értéke: 1 – amely a dokumentum legelső oldalát jelenti. A dokumentum oldalainak számánál nagyobb érték esetén is az alapértelmezett értéket veszi fel. Ha az értéke -1 akkor az utolsó oldalt jelenti.

Paraméter:

• LONG pageno – Oldal száma.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgAlign([in] LONG align);

A látható PDF aláírás igazítása a megadott sarokba.

Paraméter:

• LONG align - A lap sarkának azonosítója. Lehetséges értékei:
  • 0 - SIG_LEFT_BOTTOM Igazítás a jobb felső sarokba.
  • 1 - SIG_RIGHT_BOTTOM Igazítás a jobb alsó sarokba.
  • 2 - SIG_LEFT_TOP Igazítás a bal felső sarokba.
  • 3 - SIG_RIGHT_TOP Igazítás a bal alsó sarokba.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgSize([in] LONG size, [in] VARIANT_BOOL percent, [in] LONG mode);

A látható PDF aláírás létrehozásánál megadhatjuk a megadott kép átméretezésre vonatkozó paramétereket.

Paraméterek:

• LONG size – Képméret.
• VARIANT_BOOL percent – Ha az értéke true, akkor a size paraméter érétke képpontban értelmezett érték, ellenkező esetben a dokumentum vonatkozó méretének százalékos értékét jelenti. Például ha a dokumentum szélessége 600 képpont, size = 10 és a percent = true, akkor az új szélesség 60 képpont lesz.
• LONG mode – Az átméretezés módja. Átméretezéskor minden esetben arányosan csökkentjük, ill. növeljük a megadott kép függőleges és vízszintes méretét. Tehát az átméretezés után a magasság-szélesség aránya változatlan marad. Így a megadott size értéket többféle módon értelmezhetjük. Lehetséges értékei:
  • 0 - XS_PDF_SIGSIZEMODE_MAX Ha a kép magassága nagyobb, mint a szélessége akkor ugyanaz, mint a XS_PDF_SIGSIZEMODE_HEIGHT, különben a XS_PDF_SIGSIZEMODE_WIDTH módot használjuk. Ez az alapértelmezett üzemmód.
  • 1 - XS_PDF_SIGSIZEMODE_WIDTH A size-al megadott érték lesz az új szélessége az átméretezett képnek.
  • 2 - XS_PDF_SIGSIZEMODE_HEIGHT A size-al megadott érték lesz az új magassága az átméretezett képnek.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgPadding([in] LONG padding_x, [in] VARIANT_BOOL x_percent, [in] LONG padding_y, [in] VARIANT_BOOL y_percent);

Megadhatjuk a látható PDF aláírás vízszintes távolságát a lap széleitől.

Paraméter:

• LONG padding_x - Vízszintes behúzás. Megadhatjuk a látható aláírás vízszintes távolságát a lap szélétől, a SetPDFSignImgSize paraméterezésénél leírt módon, képpontban vagy lapméret százalékban.
• VARIANT_BOOL x_percent – Értéke true ha a padding_x értéke százalékban értendő.
• LONG padding_y – Függőleges behúzás. Megadhatjuk a látható aláírás függőleges távolságát a lap szélétől, a SetPDFSignImgSize paraméterezésénél leírt módon, képpontban vagy lapméret százalékban.
• VARIANT_BOOL y_percent – Értéke true ha a padding_y értéke százalékban értendő.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgMode([in] LONG imgMode);

Beállítható a látható PDF aláírás megjelenítésének módja.

Paraméter:

• LONG imgMode - Bemeneti paraméter. A paraméterben következő értékek szerepelhetnek:
  • 0 - SIG_SHOW Legyen látható az aláírás képe a dokumentumban.
  • 1 - SIG_HIDDEN Legyen rejtett az aláírás képe a dokumentumban.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgTitleMode([in] LONG tileMode);

A látható PDF aláíráson elhelyezett felirat megjelenítés módja

Paraméter:

• LONG tileMode - Bemeneti paraméter. A paraméterben következő értékek szerepelhetnek:
  • 0 - SIG_TM_CN Legyen látható az aláírás szövege, tartalma pedig legyen az aláíró tanúsítványában szereplő Subject.CN mező, ha nincs megadva a SetPDFSignImgTitle.
  • 1 - SIG_TM_HIDDEN Ne legyen látható szöveg a látható aláírás fölött.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgTitleAlign([in] LONG align);

A látható PDF aláíráson elhelyezett felirat igazítása valamelyik élhez.

Paraméter:

• LONG align - Bemeneti paraméter. A paraméterben következő értékek szerepelhetnek:
  • 0 - SIG_TA_BOTTOM Szöveg igazítása az alsó élhez.
  • 1 - SIG_TA_TOP Szöveg igazítása a felső élhez.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgTitle([in] BSTR title);

A látható PDF aláíráson opcionálisan elhelyezhető szöveg. Alapértelmezett értéke az aláíró tanúsítványában szereplő Subject.CN értéke.

Paraméter:

• BSTR title - Tetszőleges szöveg.

A szövegbe elhelyezhetőek az aláírás időpontjához vagy az aláírói tanúsítványhoz kapcsolódó adatok is:

• %TSD% - Aláírás dátuma %Y-%m-%d formátumban (lokális idő).
• %TSH% - Aláírás időpontja %H:%M:%SZ formátumban (lokális idő).
• %CN% - Aláírói tanúsítványban szereplő Subject.CN (common name) mező értéke.
• %OU% - Aláírói tanúsítványban szereplő Subject.OU (organization unit) mező értéke.
• %O% - Aláírói tanúsítványban szereplő Subject.O (organization) mező értéke.
• %L% - Aláírói tanúsítványban szereplő Subject.L (locality) mező értéke.
• %T% - Aláírói tanúsítványban szereplő Subject.T (title) mező értéke.
• %SERIAL% - Aláírói tanúsítvány sorozatszáma.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgTitleFontSize([in] LONG size);

A látható PDF aláíráson megjelenített szöveg betűmérete. Alapértelmezett értéke: 22

Paraméter:

• LONG size – Betűméret.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgTitlePadding([in] LONG x, [in] LONG y);

A látható PDF aláíráson elhelyezett szöveg, név távolsága a látható aláírás képének szélétől.

Paraméter:

• LONG x - A látható aláíráson elhelyezett szöveg, név vízszintes irányú távolsága a látható aláírás képének szélétől. Ha nincs megadva a látható aláírás képe és nincs is tiltva a megjelenítése, akkor ennek a paraméternek nincs hatása.
• LONG y - A látható aláíráson elhelyezett szöveg, név függőleges irányú távolsága a látható aláírás képének szélétől. Ha nincs megadva a látható aláírás képe és nincs is tiltva a megjelenítése, akkor ennek a paraméternek nincs hatása.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignImgAdjPosDisable ([in] VARIANT_BOOL adjPosDisable);

A látható aláírások egymást elfedő takarását megakadályozó korrekciónak az engedélyezése, ill. tiltása. Alapértelmezett értéke: true

Paraméter:

• VARIANT_BOOL adjPosDisable – Ha az értéke true és az újonnan létrehozni kívánt aláírás képe eltakarna egy már a dokumentumon szereplő aláírást, akkor az új aláírást automatikusan eltolja úgy, hogy a takarás megszűnjön.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFPAdES([in] LONG pades);

ETSI (TS 102 778) szabványnak megfelelő PAdES aláírás készítését teszi lehetővé. Alapértelmezett értéke: SIG_PADES_DIS (0)

Paraméter:

• LONG pades – Bemeneti paraméter, a paraméterben a következő értékek szerepelhetnek:
  • 0 - SIG_PADES_DIS PAdES aláírás kikapcsolva.
  • 1 - SIG_PADES_ENA PAdES aláírás engedélyezve.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFSignaturePolicy([in] BSTR sigPolicyURI, [in, defaultvalue("")] BSTR sigPolicyOID);

A PDF aláíráson értelmezett aláírási szabályzat URI-ja és OID-ja (ha szükséges), XAdES-EPES létrehozásához. Nincs alapértelmezett értéke.

Paraméter:

• BSTR sigPolicyURI - Aláírási szabályzat URI-ja. Nincs alapértelmezett értéke.
• BSTR sigPolicyOID - Aláírási szabályzat OID-ja, akkor szükséges megadni, ha a szabályzat nem ASN1 formátumú.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFCommitmentType([in] BSTR commitmentTypeOID);

A PDF aláíráson értelmezett kötelezettség-vállalás, OID-ként megadva. Nincs alapértelmezett értéke.

Paraméter:

• String commitmentTypeOID - Az aláíró kötelezettség-vállalása. CAdES szabvány szerinti lehetséges értékek:
• 1.2.840.113549.1.9.16.6.1 – eredet igazolása
• 1.2.840.113549.1.9.16.6.2 – átvételi elismervény
• 1.2.840.113549.1.9.16.6.3 – kézbesítés igazolása
• 1.2.840.113549.1.9.16.6.4 – elküldés igazolása
• 1.2.840.113549.1.9.16.6.5 – jóváhagyás
• 1.2.840.113549.1.9.16.6.6 – létrehozás igazolása

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetPDFContentHint([in] BSTR contentHintDescription, [in] BSTR contentHintType);

A PDF aláíráshoz megadható paraméter, amely multi-layer message esetén a belső tartalom típusát jelöli. Nincs alapértelmezett értéke.

Paraméter:

• String contentHintDescription - Multi-layer message esetén a belső tartalom típusát írja le. Értéke jellemzően mime típus. Nincs alapértelmezett értéke. Részletes leírás az RFC 2634 [5] dokumentumban és az ETSI TS 101 733 leírásban található.
• String contentHintType - Multi-layer message esetén a belső tartalom típusát megadó OID. Nincs alapértelmezett értéke. Részletes leírás az RFC 2634 [5] dokumentumban és az ETSI TS 101 733 leírásban található.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG GetHandle();

Az aktuális szálhoz tartozó handle-t kérhetjük le. A handle segítségével másolhatjuk át két össze nem tartozó szál közt a globális beállításokat.

Visszatérési érték:

Az aktuális szálhoz tartozó handle értéke.

LONG ForkInstance([in] LONG sessionHandle);

A megadott szál globális beállításairól készít egy másolatot. Az aktuális szálban ezeket a beállításokat anélkül módosíthatjuk, hogy a módosításaink érintenék a paraméterben megadott szál beállításait (ezáltal külön beállításokat lehet használni a különböző szálakban).

Paraméter:

• LONG handle – Bemeneti paraméter. Annak a szálnak a handle-je, melynek a beállításairól szeretnénk egy másolatot készíteni. Ld. GetHandle(). NULL esetén a fő szál beállításait másolja át a metódus.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

Ha a bemeneti paraméterként a saját szálunk handle-jét adtuk meg akkor (XSR_INVALID_OPERATION) hibát kapunk.

void ReleaseInstance([in] LONG handle);

A ForkInstance([in] LONG sessionHandle) metódussal korábban létrehozott új szálhoz tartozó beállítások leíróját elengedi.

Paraméter:

• long handle – Bemeneti paraméter. Egy szálhoz tartozó beállítások handle-je, melyet szeretnénk felszabadítani.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

Ha a fő szál handle-jét adtuk meg akkor (XSR_INVALID_OPERATION) hibát kapunk.

LONG SetDigestAlgorithm([in] LONG digestAlgo);

A használandó lenyomatképző algoritmus az aláírás létrehozása esetén. Alapértelmezett értéke „sha256”.

Paraméterek:

• long digestAlgorithm – Bemeneti paraméter. A használandó lenyomatképző algoritmus azonosítója. Lehetséges értékei:
  • 1 - sha1 lenyomatképző algoritmus
  • 3 - sha256 lenyomatképző algoritmus
  • 4 - sha384 lenyomatképző algoritmus
  • 5 - sha512 lenyomatképző algoritmus

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetOutputEncoding([in] LONG outputEncoding);

A paraméter az e-akta mentésekor az XML kódolását állítja be.

Paraméterek:

• LONG outputEncoding – Bemeneti paraméter. Értéke határozza meg a létrehozandó e-akták kódolását. Lehetséges értékei:
  • 0 - local kódolás
  • 1 – UTF-8 kódolás

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetLocale([in] BSTR locale);

A státuszüzenetek nyelvét állíthatjuk be a paraméter segítségével.

Paraméterek:

• BSTR locale – Bemeneti paraméter. A string lehetséges értékei: „eng”, „ger”, „hun”

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetEncryptingPass([in] BSTR password, [in] BSTR encryptingAlgo);

A szimmetrikus kulcsú titkosításhoz használandó jelszót és titkosító algoritmust adhatjuk meg a metódus segítségével.

Paraméterek:

• BSTR password – Bemeneti paraméter. A titkosításhoz és a titkosítás feloldásához használandó jelszó.
• BSTR encryptingAlgo – Bemeneti paraméter. A szimmetrikus kulcsú titkosításhoz használandó algoritmus azonosítója. Az azonosítók az openssl szerint definiált algoritmus azonosítók, pl.: aes-128-cbc. Teljes lista az alábbi oldalon található: http://www.openssl.org/docs/apps/enc.html. Amennyiben üres stringet adunk át paraméterként értéke „aes-128-cbc” lesz.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG setEncryptingSymmetricKey ([in] BSTR key, [in] BSTR encryptingAlgo);

A szimmetrikus kulcsú titkosításhoz használandó kulcsot és titkosító algoritmust adhatjuk meg a metódus segítségével.

Paraméterek:

• BSTR key – Bemeneti paraméter. A titkosításhoz és a titkosítás feloldásához használandó kulcs, melyet hexa string formájában adhatunk meg.
• BSTR encryptingAlgo – Bemeneti paraméter. A szimmetrikus kulcsú titkosításhoz használandó algoritmus azonosítója. Az azonosítók az openssl szerint definiált algoritmus azonosítók, pl.: aes-128-cbc. Teljes lista az alábbi oldalon található: http://www.openssl.org/docs/apps/enc.html. Amennyiben üres stringet adunk át paraméterként értéke „aes-128-cbc” lesz.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetIgnoreKeyUsage([in] VARIANT_BOOL ignore);

E paraméterrel beállítható, hogy az e-Szignó figyelembe vegye-e az aláírói tanúsítványban lévő kulcshasználat biteket az aláírás létrehozásakor vagy ellenőrzésekor.

Paraméter:

• VARIANT_BOOL ignore - Amennyiben e paraméter értéke VT_TRUE, a program nem ellenőrzi a kulcshasználat mezőt, figyelmen kívül hagyja azt. Az alapértelmezett esetben (VT_FALSE beállítás) az aláírói tanúsítványban a kulcshasználat biteknek meg kell felelniük a vonatkozó szabványoknak, jogszabályoknak (a digitalSignature és/vagy a nonRepudiation bit kötelező).

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetOnlyQualifiedSignatures([in] VARIANT_BOOL val);

E paraméterrel beállítható, hogy a program csak minősített aláírói tanúsítványokat fogadjon el, amelyekhez tartozó privátkulcs BALE eszközön található.. (Ilyenkor a tanúsítványban található qcStatements kiterjesztést ellenőrzi az e-Szignó.) Ez a függvény elavult, használja helyette a SetSigRequirementsLevel függvényt.

Paraméter:

• VARIANT_BOOL val - Amennyiben e paraméter értéke VT_TRUE, a program csak megfelelő qcStatements kiterjesztéssel rendelkező aláírói tanúsítványokat fogad el.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetSigRequirementsLevel([in] LONG value);

Ezzel a függvény beállíthatjuk, hogy a modul mit követeljen meg az aláírói tanúsítványoktól.

Paraméter:

• LONG value – Bemeneti paraméter. Az aláírói tanúsítványokkal szemben támasztott követelmények szintje.
  • 0 - XS_SIGREQLEVEL_QCERT_ALL A modul minden tanúsítványt elfogad.
  • 1 - XS_SIGREQLEVEL_QCERT A modul csak minősített tanúsítványokat fogad el, de nem szükséges, hogy a tanúsítványhoz tartozó privátkulcsok BALE eszközön legyenek.
  • 2 - XS_SIGREQLEVEL_QCERT_SSCD A modul csak minősített tanúsítványokat fogad el, és a tanúsítványhoz tartozó privátkulcsoknak BALE eszközön kell lennie.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetCAdES([in] VARIANT_BOOL val);

Beállítja, hogy a PKCS #7/CMS alapú aláírások ellenőrzésekor és létrehozásakor a minimális követelmény a CAdES legyen-e (konkrétan: bekerüljön-e az aláírásba a CAdES által megkövetelt id-smime-aa-signingCertificate aláírt tulajdonság, ill. elfogadjon-e olyan aláírásokat, amelyekben az nem található). Amennyiben értéke false, a létrehozott aláírások a CAdES-nek nem felelnek meg (!), és ellenőrzéskor elfogadja a nem CAdES aláírásokat is. Alapértelmezett értéke true. Hatással van a CMS és PDF aláírások létrehozására, valamint a CMS aláírások ellenőrzésére. (A PDF aláírások ellenőrzésekor az e-Szignó a vonatkozó szabvány sajátosságai miatt mindig elfogadja a nem CAdES aláírásokat is.)

Paraméter:

• VARIANT_BOOL val – VT_TRUE vagy VT_FALSE. (Ld. Leírás.)

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

VARIANT* SignCM([in] VARIANT* content, [in] BSTR sContentType, [in] VARIANT_BOOL bDetached);

CMS aláírás készítése.

Paraméterek:

• VARIANT* content – Bemeneti paraméter. Az aláírandó bájtsorozat. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal)
• BSTR sContentType – Bemeneti paraméter. Az aláírandó bájtsorozat típusát meghatározó OID „pontozott” formátumban. Üres karaktersorozat esetén az alapértelmezett értéke „1.2.840.113549.1.7.1” (bináris adattípus).
• VARIANT_BOOL bDetached – Bemeneti paraméter. Különálló CMS aláírás létrehozása. VARIANT_TRUE esetén a content paraméterben megadott bájtsorozat nem kerül beillesztésre.

Visszatérési érték:

A CMS aláírás. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal.) Hiba esetén NULL. Ilyenkor a hibakód lekérhető egy XSignSession::GetLastError() hívással.

VARIANT* VerifyCM([in] VARIANT* signature, [in] VARIANT* content);

CMS aláírás ellenőrzése.

Paraméterek:

• VARIANT* signature – Bemeneti paraméter. A CMS aláírást tartalmazó bájtsorozat. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal)
• VARIANT* content – Bemeneti paraméter. Különálló CMS aláírás esetén meg kell adni az aláírt bájtsorozatot is, különben lehet üres bájtsorozat. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal)

Visszatérési érték:

Az aláírt bájtsorozat. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal.) Hiba (pl. sérült vagy érvénytelen aláírás) esetén NULL. Ilyenkor a hibakód lekérhető egy XSignSession::GetLastError() hívással.

LONG SetSrvCertValidation([in] VARIANT_BOOL validateSrvCerts);

Megadható, hogy SSL kapcsolódás esetén (pl. https címek használatakor) az e-Szignó ellenőrizze a távoli szerver tanúsítványát. Alapértelmezés szerint be van kapcsolva ez a funkció.

Paraméter:

• VARIANT_BOOL validateSrvCerts – VT_TRUE vagy VT_FALSE.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetSrvCertRevChkDisable([in] BSTR sURLList);

A paraméter segítségével megadható, hogy SSL kapcsolódás esetén (pl. https címek használatakor) az e-Szignó ha ellenőrzi a távoli szerver tanúsítványát, akkor mely címek esetében nem kell ellenőriznie a visszavonási állapotot.

Paraméter:

• BSTR sURLList - Bemeneti paraméter. Szóközzel elválasztott URL-ek listája.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetURLRedirect([in] BSTR sURLPairList);

A megadott URL párok első tagjához történő kapcsolódás helyett minden esetben a második értékként megadott URL lesz használva.

Paraméter:

• BSTR sURLPairList - szóközökkel elválasztott URL párok.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

VARIANT SendData(VARIANT* in, BSTR sURL, BSTR sName, BSTR sFilename);

Állomány feltöltése HTTP-n keresztül.

Paraméterek:

• VARIANT* in – a feltöltendő bájtsorozat (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal.)
• BSTR sURL - az URL
• BSTR sName - a mező neve az űrlapon
• BSTR sFilename – az állomány neve az űrlapon

Visszatérési érték:

HTTP válasz. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal.) Hiba esetén NULL. Ilyenkor a hibakód lekérhető egy XSignSession::GetLastError() hívással.

LONG SetCertAuthList(IDispatch* pCertAuthList);

Ezen metódus segítségével adhatjuk meg, mely host-okhoz mely PFX fájlokkal kapcsolódhatunk.

Paraméter:

• IDispatch* pCertAuthList –Egy objektum, mely megadja az autentikációs adatokat; típusa IXSignHostCertAuthList.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetBasicAuthList(IDispatch* pBasicAuthList);

Ezen metódus segítségével adhatjuk meg, mely host-okhoz mely felhasználónév/jelszóval kapcsolódhatunk.

Paraméter:

• IDispatch* pBasicAuthList –Egy objektum, mely megadja az autentikációs adatokat; típusa IXSignBasicAuthList.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetXmlIds(VARIANT* pXmlIds);

A megadott elemek attribútumait ID típusúként kezeli az XSign4COM.

Paraméter:

• VARIANT* pXmlIds – az XML azonosító elemek tömbje (SAFEARRAY tömbben VT_ARRAY | VT_DISPATCH típussal.).

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetSigningCertificatePKCS11([in] BSTR pkcs11ModulePath, [in] LONG keyRefType, [in] BSTR keyRefValue, [in] BSTR pass);

Az aláíró tanúsítványt lehet beállítani. A tanúsítvány PKCS#11-es függvénykönyvtáron keresztül érhető el.

Paraméterek:

• BSTR pkcs11ModulePath – A PKCS#11-es függvénykönyvtár elérési útja.
• long keyRefType – Bemeneti paraméter. Értéke határozza meg a keyRefValue változó típusát. Lehetséges értékei: 1 – tanúsítvány CN; 2 – tanúsítvány SHA-1 lenyomat.
• BSTR keyRefValue – Bemeneti paraméter. A tanúsítvány kiválasztásához használandó adat, típusát a keyRefType paraméter határozza meg.
• BSTR pass – A kulcshoz tartozó PIN kód.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetSigningCertificatePKCS11v2([in] BSTR pkcs11ModulePath, [in] LONG keyRefType,
[in] BSTR keyRefValue, [in] BSTR sUserPIN, [in] BSTR sContextSpecificPIN);

Az aláíró tanúsítványt lehet beállítani. A tanúsítvány PKCS#11-es függvénykönyvtáron keresztül érhető el.

Paraméterek:

• BSTR pkcs11ModulePath – A PKCS#11-es függvénykönyvtár elérési útja.
• long keyRefType – Bemeneti paraméter. Értéke határozza meg a keyRefValue változó típusát. Lehetséges értékei: 1 – tanúsítvány CN; 2 – tanúsítvány SHA-1 lenyomat.
• BSTR keyRefValue – Bemeneti paraméter. A tanúsítvány kiválasztásához használandó adat, típusát a keyRefType paraméter határozza meg.
• BSTR sUserPIN – A PKCS#11-es token felhasználói PIN kódja. Olyankor kell megadni, ha a tokennel olyan kriptográfiai műveletet (aláírás vagy kititkosítás) szeretnénk végrehajtani, ami hitelesítést igényel. (További információért olvassa el a PKCS#11: Cryptographic Token Interface Standard Version 2.20).
• BSTR sContextSpecificPIN – A PKCS#11-es token környezet specifikus PIN kódja. Olyankor kell megadni, ha egy kulcs minden használat (aláírás vagy kititkosítás) előtt hitelesítést igényel. (További információért olvassa el a PKCS#11: Cryptographic Token Interface Standard Version 2.20)

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetCheckTrustedCertValidity([in] VARIANT_BOOL check);

Amennyiben az érteke VT_FALSE, akkor nem ellenőrzi a megbízhatónak elfogadandó tanúsítványok lejáratát. Alapértelmezés szerint be van kapcsolva ez a funkció.

Paraméterek:

• VARIANT_BOOL check – VT_TRUE vagy VT_FALSE.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetUseWindowsCertStore([in] VARIANT_BOOL useIt);

A függvény segítségével beállíthatjuk, hogy a tanúsítványlánc építésekor honnan vegye a közbenső szintű és a megbízható tanúsítványokat. Ha a paraméter érteke VT_TRUE, akkor a Windows tanúsítványtárának segítségével épül föl a tanúsítványlánc, ha VT_FALSE, akkor a felhasználó által megadott könyvtárakat használja a modul. Alapértelmezett esetben a Windows tanúsítványtárat fogja használni a modul.

Paraméterek:

• VARIANT_BOOL check – VT_TRUE vagy VT_FALSE. Bemeneti paraméter. Megadja, hogy használja-e a modul a Windows tanúsítványtárat.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetTrustedCertDir([in] BSTR dirPath);

Megadhatjuk azoknak a könyvtáraknak az elérési útjait, melyekben a megbízható tanúsítványok találhatók. Abban az esetben, amikor nem a Windows tanúsítványtárat használjuk a tanúsítványlánc felépítésére, akkor ebből a könyvtárból veszi a modul a megbízható tanúsítványokat. Ez a függvény akkor használható, ha a SetUseWindowsCertStore([in] VARIANT_BOOL useIt) függvény VT_FALSE értékkel meg van hívva. A megadott beállítás az aláírás ellenőrzésre és az időbélyeg és OCSP válaszok aláírásaikor használt aláírások ellenőrzésére is vonatkozik.

Paraméterek:

• BSTR dirPath – Bemeneti paraméter. A megbízható tanúsítványokat tartalmazó könyvtárak elérési útjai pontosvesszővel elválasztva.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetSignerTrustedCertDir([in] BSTR dirPath);

Megadhatjuk azoknak a könyvtáraknak az elérési útjait, melyekben az aláírás ellenőrzésekor használt megbízható tanúsítványok találhatók. Abban az esetben, amikor nem a Windows tanúsítványtárat használjuk a tanúsítványlánc felépítésére, akkor ebből a könyvtárból veszi a modul a megbízható tanúsítványokat. Ez a függvény akkor használható, ha a SetUseWindowsCertStore([in] VARIANT_BOOL useIt) függvény VT_FALSE értékkel meg van hívva.

Paraméterek:

• BSTR dirPath – Bemeneti paraméter. A megbízható tanúsítványokat tartalmazó könyvtárak elérési útjai pontosvesszővel elválasztva.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetTSATrustedCertDir([in] BSTR dirPath);

Megadhatjuk azoknak a könyvtáraknak az elérési útjait, melyekben az időbélyeg válaszokon levő aláírások ellenőrzésekor használt megbízható tanúsítványok találhatók. Abban az esetben, amikor nem a Windows tanúsítványtárat használjuk a tanúsítványlánc felépítésére, akkor ebből a könyvtárból veszi a modul a megbízható tanúsítványokat. Ez a függvény akkor használható, ha a SetUseWindowsCertStore([in] VARIANT_BOOL useIt) függvény VT_FALSE értékkel meg van hívva.

Paraméterek:

• BSTR dirPath – Bemeneti paraméter. A megbízható tanúsítványokat tartalmazó könyvtárak elérési útjai pontosvesszővel elválasztva.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetOCSPTrustedCertDir([in] BSTR dirPath);

Megadhatjuk azoknak a könyvtáraknak az elérési útjait, melyekben az OCSP válaszokon levő aláírások ellenőrzésekor használt megbízható tanúsítványok találhatók. Abban az esetben, amikor nem a Windows tanúsítványtárat használjuk a tanúsítványlánc felépítésére, akkor ebből a könyvtárból veszi a modul a megbízható tanúsítványokat. Ez a függvény akkor használható, ha a SetUseWindowsCertStore([in] VARIANT_BOOL useIt) függvény VT_FALSE értékkel meg van hívva.

Paraméterek:

• BSTR dirPath – Bemeneti paraméter. A megbízható tanúsítványokat tartalmazó könyvtárak elérési útjai pontosvesszővel elválasztva.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetSSLTrustedCertDir([in] BSTR dirPath);

Megadhatjuk azoknak a könyvtáraknak az elérési útjait, amelyekben azok a tanúsítványok találhatóak, amelyeket a webserverek tanúsítványainak ellenőrzésekor megbízható tanúsítványnak fogadunk el. Abban az esetben, amikor nem a Windows tanúsítványtárat használjuk a tanúsítványlánc felépítésére, akkor ebből a könyvtárból veszi a modul a megbízható tanúsítványokat. Ez a függvény akkor használható, ha a SetUseWindowsCertStore([in] VARIANT_BOOL useIt) függvény VT_FALSE értékkel meg van hívva.

Paraméterek:

• BSTR dirPath – Bemeneti paraméter. A megbízható tanúsítványokat tartalmazó könyvtárak elérési útjai pontosvesszővel elválasztva.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetIntermediateCertDir ([in] BSTR dirPath);

Megadhatjuk azoknak a könyvtáraknak az elérési útjait, melyekben a közbenső szintű tanúsítványok találhatók. Abban az esetben, amikor nem a Windows tanúsítványtárat használjuk a tanúsítványlánc felépítésére, akkor ebből a könyvtárból veszi a modul a közbenső szintű tanúsítványokat. Ezért ez a függvény akkor használható, ha a SetUseWindowsCertStore([in] VARIANT_BOOL useIt) függvény VT_FALSE értékkel meg van hívva.

Paraméterek:

• BSTR dirPath – Bemeneti paraméter. A közbenső szintű tanúsítványokat tartalmazó könyvtárak elérési útjai pontosvesszővel elválasztva.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG ValidateCertificate(VARIANT* encodedCert);

Ellenőrzi a megadott X.509 tanúsítvány érvényességét.

Paraméterek:

• VARIANT* encodedCert – a PEM vagy DER kódolt tanúsítvány bájtsorozat SAFEARRAY formájában. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal.)

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetMelaszReadyVersion(LONG version);

E metódus segítségével az e-Szignó által létrehozott fájlokra vonatkozó MELASZ Ready (magyar interoperábilitási) szabvány verzióját lehet beállítani. Néhány esetben az ellenőrzési beállítások is módosulnak.

Paraméter:

• LONG version – Bemeneti paraméter. A MELASZ Ready verziót állíthatjuk be vele.

Amennyiben értéke 1, azaz XS_MELASZ_READY_1_0, az e-Szignó a friss ARL-ek (Authority Revocation List – Hitelesítés-szolgáltatói Visszavonási Lista) kibocsátását nem várja meg, és az OCSP válaszok ellenőrzésénél 30 perces kivárási időt alkalmaz. További érintett beállítások:

• Kimeneti kódolás: UTF-8. (Ellenőrzéskor nincs hatása, tehát elfogad egyéb kódolású XML-t is.)
• Inkluzív XML kanonizálás. (http://www.w3.org/TR/2001/REC-xml-c14n-20010315) Nem kerül ellenőrzésre.
• Kivárási idő alkalmazása.
• A dokumentumokat nem tömöríti az e-Szignó. Nem kerül ellenőrzésre.
• A XAdES verzió értéke 1.2.2. Nem kerül ellenőrzésre.

Amennyiben értéke 2, azaz XS_MELASZ_READY_2_0, a következő beállítások és értékek módosulnak:

• Az aktába bekerül a http://www.melasz.hu/uri/ready/xades/v.2.0.0 hivatkozás XML megjegyzésként. Nem kerül ellenőrzésre.
• Az e-Szignó a friss ARL-ek (Authority Revocation List – Hitelesítés-szolgáltatói Visszavonási Lista) kibocsátását nem várja meg.
• Kimeneti kódolás: UTF-8. (Ellenőrzéskor nincs hatása, tehát elfogad egyéb kódolású XML-t is.)
• Inkluzív XML kanonizálás. (http://www.w3.org/TR/2001/REC-xml-c14n-20010315) Nem kerül ellenőrzésre.
• Visszavonás ellenőrzésnél kivárási időt alkalmaz.
• 1.3.2-es verziójú XAdES aláírást készít. Nem kerül ellenőrzésre.
• A dokumentumokat nem tömöríti az e-Szignó. Nem kerül ellenőrzésre.

A 0 (nulla) értékkel kikapcsolhatjuk a MELASZ Ready követelményeknek való megfelelést (ez az alapértelmezett beállítás).

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetSigningPFX([in] BSTR pfxPath, [in] BSTR pfxPassword);

Beállítja az aláíráskor használandó PFX (PKCS #12) fájl elérési útját és jelszavát. Ez a függvény akkor használható, ha a SetUseWindowsCertStore([in] VARIANT_BOOL useIt) függvény VT_FALSE értékkel meg van hívva.

Paraméterek:

• BSTR pfxPath – a PFX fájl elérési útja.
• BSTR pfxPassword – a PFX fájl jelszava.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetMainWindow(LONGLONG hParentWnd);

Az XSign a működése során feldobhat modális dialógus ablakokat. Például tanúsítvány kiválasztó dialógust. Ezen függvény segítségével megadhatunk egy olyan ablakot, amelyet az XSign-t felhasználó alkalmazás hozott létre, és az XSign által feldobott ablakok ezen ablakhoz fognak kapcsolódni. Amíg az XSign által feldobott ablakot a felhasználó nem zárja be, a megadott alkalmazás ablakon nem lehet műveleteket végezni.

Paraméter:

• LONGLONG hParentWnd – Bemeneti paraméter. Az alkalmazás ablak Win32 handle-je.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

Megjegyzés:

Az XSign által feldobható ablakokat befolyásolja a SetWorkSilent() függvénnyel beállított érték.

LONG SetProxySettings(BSTR proxyAddress, LONG proxyPort, BSTR userName,
BSTR userPassword, VARIANT_BOOL bypassProxyForLocal);

Ezen metóduson keresztül adhatóak meg a proxy beállítások.

Paraméter:

• BSTR proxyAddress – A proxy szerver címe.
• LONG proxyPort – A proxy szerver portja.
• BSTR userName – Amennyiben a proxy szerver felhasználó azonosítást követel meg, ebben a változóban kell megadnia felhasználónevet.
• BSTR userPassword – Amennyiben a proxy szerver felhasználó azonosítást követel meg, ebben a változóban kell megadnia jelszót.
• VARIANT_BOOL bypassProxyForLocal – Segítségével beállíthatjuk, hogy helyi címekre is érvényes legyen-e a proxy beállítás. TRUE érték esetén, figyelmen kívül hagyja az alkalmazás a proxy beállításokat a helyi címek esetén.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG EnableCURLDebug(VARIANT_BOOL enable);

A metódus segítségével bekapcsolhatjuk a CURL modul naplózását.

Paraméterek:

• VARIANT_BOOL enable – Bemeneti paraméter. VARIANT_TRUE érték esetén a naplózást bekapcsolja a program, VARIANT_FASLSE esetén nem naplóz az alkalmazás.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetReferenceCanonicalizationMethod(LONG version);

Az XMLDSIG szabványnak megfelelő XML kanonizálások közül melyiket használja (c14n_incl, c14n_incl_wc, c14n_excl, c14n_excl_wc).

Paraméter:

• LONG referenceCanonicalizationMethod – Bemeneti paraméter. Lehetséges értékei:
• 0 - c14n_incl, azaz inkluzív kanonizáció
• 1 - c14n_incl_wc, azaz inkluzív kanonizáció megjegyzéssel
• 2 - c14n_excl, azaz exkluzív kanonizáció
• 3 - c14n_excl_wc, azaz exkluzív kanonizáció megjegyzéssel

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetTSRequestPolicyID(BSTR policyID);

Időbélyeg kérésben állítja be a hitelesítési rend OID-t.

Paraméter:

• BSTR policyID – Bemeneti paraméter. Hitelesítési rend OID

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetTSCertRequest(VARIANT_BOOL setCertRequest);

Beállítja az időbélyeg kérésbe, hogy az időbélyegző szerver a válaszba beletegye-e a szolgáltatói tanúsítványát.

Paraméter:

• VARIANT_BOOL setCertRequest – Bemeneti paraméter. TRUE esetén az időbélyeg válaszban benne lesz a szolgáltatói tanúsítvány. Alapértelmezett értéke TRUE.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetJNIEnv(VARIANT* JNIEnv);

A java futtatókörnyezetre mutató pointert lehet megadni a session számára. Így java-ból is használható a COM-os interfész.

Paraméter:

• VARIANT* JNIEnv – Bemeneti paraméter. A beállítani kívánt java környezetre mutató pointer .

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch* ESignCreate

Visszaad egy inicializált ESign objektumot, amelynek segítségével az ESign protokoll futtatható. Részletes információ elérhető az IXSignESign leírásánál.

Visszatérési érték:

Egy új CXSignESign objektum.

LONG SetBasicAuth(BSTR login, BSTR password, BSTR host)

Adott domain-hez beállítja az alapértelmezett felhasználónév-jelszó párost. A SetDefaultBasicAuth általánosított változata.

Paraméterek:

• BSTR login – felhasználónév
• BSTR password – jelszó
• BSTR host – hoszt (pl. valami.hu)

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetTSLUsage(LONG useTSL, BSTR tslCacheDir, BSTR rootTSLURL, BSTR TSLTrustedCertDir);

Segítségével a beállítható, hogy az alkalmazás aláírás létrehozáskor és ellenőrzéskor használja-e az EU Trust Service status List (TSL)-t.

Paraméterek:

• LONG tslUsage – Megadja, hogy az alkalmazás használja-e a TSL-t. Értéke Session.TSLUsage értéke lehet. Lehetséges értékei:
  • 0 - XS_DONT_USE_TSL: Nem használ az alkalmazás TSL-t.
  • 1 - XS_USE_ONLY_TSL: Az alkalmazás csak TSL-t használ.
  • 2 - XS_USE_TSL: Az alkalmazás TSL-t és más forrásokat is használ a láncépítés során.
• BSTR tslCacheDir – Könyvtár elérési útja. Az alkalmazás ebbe a könyvtárba fogja tenni a TSL-hez tartozó ideiglenes fájlokat.
• BSTR rootTSLURL – A TSL-ek listáját tartalmazó listának az elérési helye.
• BSTR tslTrustedCertDir – Annak a könyvtárnak az elérési útja, amely tartalmazza a root TSL ellenőrzéséhez szükséges aláíró tanúsítványt.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch* ASiC_NewContainer

Létrehoz egy új ASiC konténert. Részletes információ elérhető az IXSignASiCContainer leírásánál.

Visszatérési érték:

Egy új CXSignASiCContainer objektum.

IDispatch* ASiC_OpenContainer(BSTR containerPath, ULONG docSizeLimit)

Megnyit egy létező ASiC konténert a fájlrendszerből.

Paraméterek:

• BSTR containerPath – Bemeneti paraméter. A konténer elérési útja a fájlrendszerben.
• ULONG docSizeLimit – Bemeneti paraméter. A konténer dokumentumainak méretlimitje, opcionális paraméter. Részletes információ elérhető az IXSignASiCContainer::InsertDocument függvény leírásánál.

Visszatérési érték:

Egy új CXSignESign objektum.

LONG Save(BSTR dossierPath);

Az aktuális e-aktát elmenti a fájlrendszerbe a dossierPath paraméterben megadott elérési útra a megadott névvel.

Paraméter:

• BSTR dossierPath – Bemeneti paraméter. A mentendő fájl nevét kell megadni teljes elérési úttal.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG GetLastError();

Az utolsó művelet sikerességéről szóló információt (XSign hibakódot, lásd az XSign visszatérési értékek című alfejezetet) kérhetjük le.

Visszatérési érték:

Az XSign legutóbbi visszatérési értéke (lásd XSign visszatérési értékek című alfejezet).

IDispatch * InsertDocument(BSTR documentPath);

Fájlrendszerből beilleszt egy dokumentumot az elektronikus aktába. A dokumentum címe a beillesztett fájl neve lesz. A dokumentum címe később megváltoztatható. Windows operációs rendszeren az alkalmazás automatikusan felismeri a fájl MIME típusát, ha az be van regisztrálva a Windowsba.

Paraméter:

• BSTR dossierPath – Bemeneti paraméter. A beillesztendő dokumentum elérési útja.

Visszatérési érték:

Egy új IXSignDocument interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dokumentumhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * Sign();

Aláírja az elektronikus aktát. Ez az aláírás magát az aktát írja alá, ez azt jelenti, hogy egyben a dossziéban szereplő összes dokumentum is aláírásra kerül. Az aláírás után az e-akta tartalma nem módosítható, nem lehet belőle dokumentumokat törölni, vagy beilleszteni. Újabb aláírás elhelyezhető az aktán.

Az elkészülő aláírás típusa nagymértékben függ a session beállításaitól, így az aláírás típus, az időbélyeg és a visszavonási információk beállításától. Ha be van állítva alapértelmezett aláírói tanúsítvány, akkor azzal történik az aláírás, ha nincs, akkor a modul a felhasználóval választtatja ki az aláíráshoz használni kívánt tanúsítványt. Hasonlóképpen történik az időbélyeg és OCSP szolgáltatások esetében is. Ezekről a beállításokról részletesebben az IXSignSession interfész leírásánál olvashatnak.

Visszatérési érték:

Egy új IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * SignWithProperties(BSTR signaturePolicyURL, BSTR signaturePlacePostalCode, BSTR signaturePlaceSettlement, BSTR signaturePlaceProvince, BSTR signaturePlaceCountry, BSTR signerRole, BSTR commitmentType );

Aláírja az elektronikus aktát. Aláíráskor megadható számos az aláírás körülményével kapcsolatos adat, így például: aláírási szabályzat, aláírás helye, aláíró szerepe, ... Az aláírás után az akta tartalma nem módosítható, újabb aláírás vagy időbélyeg azonban elhelyezhető rajta. Az elkészülő aláírás típusa nagymértékben függ a session beállításaitól, így az aláírás típus, az időbélyeg és a visszavonási információk beállításától. Ha be van állítva alapértelmezett aláírói tanúsítvány, akkor azzal történik az aláírás, ha nincs, akkor a modul a felhasználóval választatja ki az aláíráshoz használni kívánt tanúsítványt. Hasonlóképpen történik az időbélyeg és OCSP szolgáltatások esetében is. Ezekről a beállításokról részletesebben az IXSignSession interfész leírásánál olvashatnak.

Paraméterek:

• BSTR signaturePolicyURL – Bemeneti paraméter. Az aláírási szabályzat URI-ja. Nincs alapértelmezett értéke.
• BSTR signaturePlacePostalCode – Bemeneti paraméter. Az aláírás helye: irányítószám. Nincs alapértelmezett értéke.
• BSTR signaturePlaceSettlement – Bemeneti paraméter. Az aláírás helye: város. Nincs alapértelmezett értéke.
• BSTR signaturePlaceProvince – Bemeneti paraméter. Az aláírás helye: megye. Nincs alapértelmezett értéke.
• BSTR signaturePlaceCountry – Bemeneti paraméter. Az aláírás helye: ország. Nincs alapértelmezett értéke.
• BSTR signerRole – Bemeneti paraméter. Az aláaró szerepe. Nincs alapértelmezett értéke.
• BSTR commitmentType – Bemeneti paraméter. Az aláíró kötelezettség-vállalása. Nincs alapértelmezett értéke. A XAdES szabvány szerinti lehetséges értékei:
  • http://uri.etsi.org/01903/v1.2.2#ProofOfOrigin – eredet igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfReceipt – átvételi elismervény
  • http://uri.etsi.org/01903/v1.2.2#ProofOfDelivery – kézbesítés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfSender – elküldés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfApproval – jóváhagyás
  • http://uri.etsi.org/01903/v1.2.2#ProofOfCreation – létrehozás igazolása

Visszatérési érték:

Egy új IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * CounterSign();

Ellenjegyzést készít az elektronikus aktára. Ez az ellenjegyzés magát az aktát írja alá, ez azt jelenti, hogy egyben a dossziéban szereplő összes dokumentum és aláírás is aláírásra kerül. Az aláírás után az e-akta tartalma nem módosítható, nem lehet belőle dokumentumokat törölni, vagy beilleszteni. Újabb aláírás elhelyezhető az aktán.

Az elkészülő aláírás típusa nagymértékben függ a session beállításaitól, így az aláírás típus, az időbélyeg és a visszavonási információk beállításától. Ha be van állítva alapértelmezett aláírói tanúsítvány, akkor azzal történik az aláírás, ha nincs, akkor a modul a felhasználóval választtatja ki az aláíráshoz használni kívánt tanúsítványt. Hasonlóképpen történik az időbélyeg és OCSP szolgáltatások esetében is. Ezekről a beállításokról részletesebben az IXSignSession interfész leírásánál olvashatnak.

Visszatérési érték:

Egy új IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az ellenjegyzéshez tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * AddTimeStamp();

Időbélyeget készít az elektronikus aktára. Ez az időbélyeg magát az aktát írja alá, ez azt jelenti, hogy egyben a dossziéban szereplő összes dokumentum is időbélyegzővel lesz ellátva. Az időbélyegzés után az e-akta tartalma nem módosítható, nem lehet belőle dokumentumot törölni, vagy újat beilleszteni. Újabb aláírás vagy időbélyeg elhelyezhető az aktán.

Az időbélyeg szolgáltató és a hozzá tartozó felhasználói adatok az IXSignSession interfész egyes metódusainak segítségével állíthatóak be.

Visszatérési érték:

Egy új IXSignSignatue interfészre mutató pointet. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * GetFirstDocument();

Az adott elektronikus aktából visszaadja az első dokumentumot. Az IXSignDossier::GetNextDocument() metódus segítségével végigiterálhatunk a dossziéban lévő összes dokumentumon.

Visszatérési érték:

Az első dokumentumhoz tartozó IXSignDocument interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dokumentumhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * GetNextDocument();

Az adott elektronikus aktából visszaadja az következő dokumentumot. Az IXSignDossier::GetFirstDocument() metódussal együtt használva végigiterálhatunk a dossziéban lévő összes dokumentumon.

Visszatérési érték:

A következő dokumentumhoz tartozó IXSignDocument interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a dokumentumhoz tartozó funkcionalitást. Sikertelen iteráció esetén, vagy ha nincs több dokumentum, akkor NULL a pointer értéke.

VARIANT GetSource();

Visszaadja az XML forrását.

Visszatérési érték:

Az XML forrása bájtsorozatként, SAFEARRAY tömbben.

IDispatch * GetFirstSignature();

Az adott elektronikus aktából visszaadja az első keretaláírást. Az IXSignDossier::GetNextSignature() metódus segítségével végigiterálhatunk a dosszién szereplő aláírásokon. Ennek a metódusnak segítségével nem kapjuk vissza a dokumentumokon szereplő aláírásokat.

Visszatérési érték:

Az első aláíráshoz tartozó IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén, vagy ha nincs aláírva a dosszié, akkor NULL a pointer értéke.

IDispatch * GetNextSignature();

Az adott elektronikus aktából visszaadja a következő keretaláírást. Az IXSignDossier::GetFirstSignature() metódussal együtt használva végigiterálhatunk a dosszién lévő összes aláíráson. Ennek a metódusnak segítségével nem kapjuk vissza a dokumentumokon szereplő aláírásokat, csak a keretaláírásokat.

Visszatérési érték:

A következő dokumentumhoz tartozó IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen iteráció esetén vagy ha nincs több dokumentum, akkor NULL a pointer értéke.

LONG SetCustomMetadata(IDispatch* pMetadataMap);

Az elektronikus aktához csatolhatunk metaadatokat. A metaadatokat név-érték párok formájában egy IXSignMetadataMap segítségével adhatjuk meg. Ezek az aktán belül XML-ben kerülnek tárolásra, ezzel megkönnyíthetjük az elektronikus akták későbbi visszakereshetőségét és kategorizálását.

Az e-akta ezeken a metaadatokon kívül egyéb metaadatokat is tartalmaz XML formában.

Paraméterek:

• BSTR pMetadataMap – Bemeneti paraméter. A beillesztendő metaadatokat tartalmazó map objektum típusa IXSignMetadataMap, amiről a hozzá tartozó fejezetben olvashatnak bővebben.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch * GetCustomMetadata();

Az e-akta metaadatait adja vissza. Ld. még IXSignDossier::SetCustomMetadata().

Visszatérési érték:

A metaadatokhoz tartozó IXSignMetadataMap interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az egyes név-érték párokat. Sikertelen lekérdezés esetén NULL a pointer értéke.

BSTR GetUnsignedHash();

Ez a metódus az összeállított e-aktából kinyeri az aláíratlan lenyomatot.

Az elosztott aláírás készítés részleteiről a IXSignDossier::SetSignedHash() függvény leírásában olvashat.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Visszatérési érték:

A base64 kódolt aláíratlan lenyomatot tartalmazó string.

LONG SetSignedHash(BSTR hash);

Az elosztott aláírás készítés harmadik lépcsőjeként az aláírt lenyomatot lehet visszahelyezni a félig kész elektronikus aktába.

A kétmenetes (elosztott) aláírás lényege, hogy az aláírást az e-Szignó program két menetben hozza létre: az első menetben a megadott tanúsítvánnyal létrehozza az aláírás XML keretét a kötelezően aláírandó metaadatokkal, valamint kiszámítja az aláírandó adatok lenyomatát, amit egy külső alkalmazásnak (pl. weboldalba illesztett ActiveX control vagy Java applet) átad aláírásra. A második menetben a külső alkalmazás által aláírt lenyomatot beilleszti a félkész aláírásba, majd ellenőrzi az aláírói tanúsítványt, esetleg időbélyeggel (XAdES-T) bőviti az aláírást.

Az aláíráshoz szükséges magánkulcs és az aláíró program fizikailag elkülönül, tipikusan a magánkulcs a kliens géphez csatlakoztatott kártyaolvasóba helyezett kártyán, az aláíró program (e-Szignó SDK) pedig a browser „túloldalán”, a HTTPS kapcsolatot kiszolgáló szervergépen fut. A kliens nem tudja a magánkulcsát eljuttatni a szerverre, hisz az „be van zárva a kártyába”, így a kliens e-Szignón kívül csak a kétmenetes aláírás marad, mint megoldás.

A kétmenetes aláírás pár előnye:

• Az XML feldolgozáshoz és a tanúsítvány ellenőrzéshez szükséges programkód egy központi szerveren fut, egységes konfigurációval.
• A lenyomat aláírása viszonylag könnyen implementálható a kliens számítógépén, ezáltal az aláírás olyan platformokon is elérhetővé válhat, ahova a teljes „arzenál” (XML feldolgozás, időbélyegzés, OCSP…) portolása nagyon sok időt venne igénybe.
• A klienseknek csak egy nagyon kis alkalmazást (ActiveX control, Java applet) kell letölteniük az aláíráshoz. („Vékony” kliens.)

A kétmenetes aláírás használatának feltétele, hogy a kliens megbizonyosodjon és megbízzon a szerver által számára elküldött lenyomat valódiságában, pl. szerver-autentikált HTTPS (SSL) kapcsolat szükséges!

Az elosztott aláírás folyamatában először be kell állítani az aláíráshoz használandó tanúsítványt az IXSignSession::SetSigningCert() metódussal, majd a kész aktának le kell kérni az aláíratlan lenyomatát az IXSignDossier::GetUnsignedHash() függvénnyel, a lenyomatot aláíratni kliens oldalon, végül az aláírt lenyomatot visszahelyezni az aktába ezzel a függvénnyel.

Ld. még az e-Szignó parancssoros interfészének dokumentációját (doc/eszigno3_ref.html).

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Paraméterek:

• BSTR hash – Bemeneti paraméter. A base64 kódolt aláírt lenyomat.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetTitle();

Az adott e-akta címét adja vissza.

Visszatérési érték:

Az e-akta címét tartalmazó string.

LONG SetTitle(BSTR newTitle);

Az adott e-akta címét állíthatjuk be. Csak akkor állíthatjuk a címet, ha az akta nincs aláírva.

Paraméterek:

• BSTR newTitle – Bemeneti paraméter. A beállítani kívánt új cím.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetType();

Az adott e-akta típusát adja vissza.

Visszatérési érték:

Az e-akta típusát tartalmazó string.

Lehetséges értékei:

• „elektronikus akta”
• „elektronikus átvételi elismervény”

BSTR GetCategory();

Az adott e-akta kategóriáját adja vissza.

Visszatérési érték:

Az e-akta kategóriáját tartalmazó string.

Lehetséges értékei:

• „electronic dossier”
• „electronic acknowledgement”

BSTR GetCreationDate();

Az adott e-akta létrehozásának időpontját adja vissza a metódus.

Visszatérési érték:

Az e-akta létrehozásának időpontját tartalmazó string. A dátum formátuma: „yyyy-MM-dd’T’HH:mm:ss’Z’”. Pl.: 2007-07-18T13:06:11Z

LONG Encrypt();

Titkosítja az e-aktát az IXSignSession::SetRecipientCertList() beállításnak megfelelően.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG Free();

Felszabadítja az e-aktával kapcsolatos memóriaterületeket az XSign DLL-en belül. Figyelem! A függvény hatására mind az e-aktát szimbolizáló XSignDossier, mind az abban található dokumentumokat ill. aláírásokat jelentő XSignDocument és XSignSignature objektumok használhatatlanná válnak. Metódusaik meghívása nem definiált működéshez vezet!

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG CheckAcknowledgement(BSTR dossierPath)

Átvételi elismervény ellenőrzése. Ha az XSignDossier objektum egy tértivevény (átvételi elismervény), akkor használható a függvény a tértivevény ellenőrzésére. Ha nem tértivevény az XSignDossier, akkor hibát jelez a metódus.

Paraméter:

• BSTR dossierPath – Bemeneti paraméter. A tértivevényhez tartozó e-akta elérési útját kell megadni (amiről az átvételi elismervény készült).

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch* Validate(VARIANT_BOOL recursive, VARIANT_BOOL forceValidateAllSignatures,
VARIANT_BOOL showProperties, LONG truncateToXAdESType, LONG addTimestamp,
VARIANT_BOOL checkDocumentFormat)

E-akta hitelességének ellenőrzése. A függvény ellenőrzi, hogy az e-akta nem üres-e, valamint hogy az összes dokumentum aláírása érvényes-e. A keretaláírás az összes dokumentum aláírásának számít. Az időbélyegek nem számítanak aláírásnak. Rekurzív módban az e-aktába illesztett e-akta típusú dokumentumok belsejét is ellenőrzi. Amennyiben egy érvénytelen aláírás „kívül” egy érvényessel „védve van”, a program elfogadja az aktát. (Pl. a dokumentum aláírása lejárt, de a keretaláírás érvényes.) Ez a működés felülbírálható a forceValidateAllSignatures paraméter használatával.

Paraméterek:

• VARIANT_BOOL recursive – megadható, hogy az e-aktába illesztett e-akták belsejét is ellenőrizze-e
• VARIANT_BOOL forceValidateAllSignatures – megadható, hogy a keretaláírással ellátott akták esetében, a belső aláírások is ellenőrzésre kerüljenek
• VARIANT_BOOL showProperties – megadható, hogy a kimeneti listában szerepeljenek-e a XAdES által megkövetelt, a későbbi ellenőrzéshez szükséges elemek
• LONG truncateToXAdESType – az ellenőrzés előtt az aláírás XAdES-típusát az új XAdES típusra csökkenti
• LONG addTimestamp – ezen opció egy bizonyos típusú időbélyegből még egy darab beillesztésére ad lehetőséget
• VARIANT_BOOL checkDocumentFormat – megadható, hogy az e-aktában lévő dokumentumok formátumát ellenőrizze-e az e-Szignó; az egyetlen, jelenleg támogatott dokumentumformátum a PDF, tehát a formátumellenőrzés csak erre fog lefutni

Visszatérési érték:

Egy új IXSignDossierValidationResult interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el a validálás eredményének hibakódját és a validálás eredményének XML kimenetét. Sikertelen művelet esetén NULL a pointer értéke.

LONG GetMainType();

Visszaadja az akta belső típusát

A visszatérési értékek a következők lehetnek:

• 0 - ismeretlen
• 2 - dosszié
• 6 - tértivevény
• 8 - megjegyzés dokumentum

LONG GetLastError();

Az utolsó művelet sikerességéről szóló információt kérhetjük le.

Visszatérési érték:

Az XSign legutóbbi visszatérési értéke (lásd XSign visszatérési értékek című alfejezet).

LONG Save(BSTR documentPath);

Az elektronikus aktában elhelyezkedő dokumentumot ki lehet menteni a fájlrendszerbe a megadott névre.

Paraméterek:

• BSTR documentPath – Bemeneti paraméter. A mentés helyét kell megadni ebben a paraméterben teljes vagy relatív elérési úttal.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch * Sign();

Aláírja az aktuális dokumentumot. Az aláírás után a dokumentum tartalma nem módosítható, újabb aláírás vagy időbélyeg azonban elhelyezhető a dokumentumon illetve az e-aktán. Az elkészülő aláírás típusa nagymértékben függ a session beállításaitól, így az aláírás típus, az időbélyeg és a visszavonási információk beállításától. Ha be van állítva alapértelmezett aláírói tanúsítvány, akkor azzal történik az aláírás, ha nincs, akkor a modul a felhasználóval választatja ki az aláíráshoz használni kívánt tanúsítványt. Hasonlóképpen történik az időbélyeg és OCSP szolgáltatások esetében is. Ezekről a beállításokról részletesebben az IXSignSession interfész leírásánál olvashatnak.

Visszatérési érték:

Egy új IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * SignWithProperties(BSTR signaturePolicyURL, BSTR signaturePlacePostalCode, BSTR signaturePlaceSettlement, BSTR signaturePlaceProvince, BSTR signaturePlaceCountry, BSTR signerRole, BSTR commitmentType );

Aláírja az aktuális dokumentumot. Aláíráskor megadahtó számos az aláírás körülményével kapcsolatos adat, így például: aláírási szabályzat, aláírás helye, aláíró szerepe, ... Az aláírás után a dokumentum tartalma nem módosítható, újabb aláírás vagy időbélyeg azonban elhelyezhető a dokumentumon illetve az e-aktán. Az elkészülő aláírás típusa nagymértékben függ a session beállításaitól, így az aláírás típus, az időbélyeg és a visszavonási információk beállításától. Ha be van állítva alapértelmezett aláírói tanúsítvány, akkor azzal történik az aláírás, ha nincs, akkor a modul a felhasználóval választatja ki az aláíráshoz használni kívánt tanúsítványt. Hasonlóképpen történik az időbélyeg és OCSP szolgáltatások esetében is. Ezekről a beállításokról részletesebben az IXSignSession interfész leírásánál olvashatnak.

Paraméterek:

• BSTR signaturePolicyURL – Bemeneti paraméter. Az aláírási szabályzat URI-ja. Nincs alapértelmezett értéke.
• BSTR signaturePlacePostalCode – Bemeneti paraméter. Az aláírás helye: irányítószám. Nincs alapértelmezett értéke.
• BSTR signaturePlaceSettlement – Bemeneti paraméter. Az aláírás helye: város. Nincs alapértelmezett értéke.
• BSTR signaturePlaceProvince – Bemeneti paraméter. Az aláírás helye: megye. Nincs alapértelmezett értéke.
• BSTR signaturePlaceCountry – Bemeneti paraméter. Az aláírás helye: ország. Nincs alapértelmezett értéke.
• BSTR signerRole – Bemeneti paraméter. Az aláaró szerepe. Nincs alapértelmezett értéke.
• BSTR commitmentType – Bemeneti paraméter. Az aláíró kötelezettség-vállalása. Nincs alapértelmezett értéke. A XAdES szabvány szerinti lehetséges értékei:
  • http://uri.etsi.org/01903/v1.2.2#ProofOfOrigin – eredet igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfReceipt – átvételi elismervény
  • http://uri.etsi.org/01903/v1.2.2#ProofOfDelivery – kézbesítés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfSender – elküldés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfApproval – jóváhagyás
  • http://uri.etsi.org/01903/v1.2.2#ProofOfCreation – létrehozás igazolása

Visszatérési érték:

Egy új IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * CounterSign();

Ellenjegyzést készít a dokumentumra Az aláírás után a dokumentum tartalma nem módosítható, újabb aláírás vagy időbélyeg azonban elhelyezhető a dokumentumon illetve az e-aktán. Az elkészülő aláírás típusa nagymértékben függ a session beállításaitól, így az aláírás típus, az időbélyeg és a visszavonási információk beállításától. Ha be van állítva alapértelmezett aláírói tanúsítvány, akkor azzal történik az aláírás, ha nincs, akkor a modul a felhasználóval választatja ki az aláíráshoz használni kívánt tanúsítványt. Hasonlóképpen történik az időbélyeg és OCSP szolgáltatások esetében is. Ezekről a beállításokról részletesebben az IXSignSession interfész leírásánál olvashatnak.

Visszatérési érték:

Egy új IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az ellenjegyzéshez tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

LONG Delete();

Törli az aktuális dokumentumot. A törlés után a dokumentum objektum érvénytelen lesz és minden rajta végrehajtott művelet hibára fut.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch * AddTimeStamp();

Időbélyeget készít az adott dokumentumra. Az időbélyegzés után a dokumentum tartalma nem módosítható, de újabb aláírás vagy időbélyeg elhelyezhető a dokumentumon vagy az e-aktán. Az időbélyeg szolgáltató és a hozzá tartozó felhasználói adatok az IXSignSession interfész egyes metódusainak segítségével állíthatók be.

Visszatérési érték:

Egy új IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * GetFirstSignature();

Az adott dokumentumhoz tartozó első aláírást vagy időbélyeget adja vissza. Az IXSignDocument::GetNextSignature() metódus segítségével végigiterálhatunk a dokumentumon szereplő aláírásokon.

Visszatérési érték:

Az első aláíráshoz tartozó IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén, vagy ha nincs aláírva a dokumentum, akkor NULL a pointer értéke.

IDispatch * GetNextSignature();

Az adott elektronikus dokumentumhoz tartozó következő aláírást vagy időbélyeget adja vissza. Az IXSignDossier::GetFirstSignature() metódussal együtt használva végigiterálhatunk a dokumentumon lévő összes aláíráson és időbélyegen.

Visszatérési érték:

Az aláíráshoz tartozó IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen iteráció esetén vagy ha nincs több aláírás, akkor NULL a pointer értéke.

BSTR GetTitle();

Az adott dokumentum címét adja vissza a metódus.

Visszatérési érték:

A dokumentum címét tartalmazó string.

LONG SetTitle(BSTR newTitle);

Az adott dokumentum címét állíthatjuk be. Csak akkor állíthatjuk a címet, ha sem az akta sem a dokumentum nincs aláírva.

Paraméterek:

• BSTR newTitle – Bemeneti paraméter. A beállítani kívánt új cím.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetMIMEType();

Az adott dokumentum MIME típusát adja vissza.

Visszatérési érték:

A dokumentum MIME típusát tartalmazó string.

BSTR GetCreationDate();

Az adott dokumentum beillesztésének dátumát adja vissza.

Visszatérési érték:

A dokumentum beillesztésének dátumát tartalmazó string.

BSTR GetType();

Az adott dokumentum típusát adja vissza.

Visszatérési érték:

A dokumentum típusát tartalmazó string a visszatérési érték.

LONG SetCustomMetadata(IDispatch* pMetadataMap);

Az adott dokumentumhoz csatolhatunk metaadatokat. A metaadatokat név-érték párok formájában egy IXSignMetadataMap segítségével adhatjuk meg. Ezek az aktán belül XML-ben kerülnek tárolásra, ezzel megkönnyíthetjük az elektronikus akták későbbi visszakereshetőségét és kategorizálását. Az e-akta ezeken a metaadatokon kívül egyéb metaadatokat is tartalmaz XML formában.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Paraméterek:

• BSTR pMetadataMap – Bemeneti paraméter. A beillesztendő metaadatokat tartalmazó map objektum típusa IXSignMetadataMap, amiről a hozzá tartozó fejezetben olvashatnak bővebben.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch * GetCustomMetadata();

A dokumentumhoz tartozó metaadatokat kérhetjük le.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Visszatérési érték:

A metaadatokhoz tartozó IXSignMetadataMap interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az egyes név-érték párokat. Sikertelen lekérdezés esetén NULL a pointer értéke.

BSTR GetExtension();

A dokumentum eredeti fájlkiterjesztését kérhetjük le.

Visszatérési érték:

A dokumentum kiterjesztését tartalmazó string.

LONG Encrypt();

Titkosítja a dokumentumot az IXSignSession::SetRecipientCertList() beállításnak megfelelően.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetObjectId();

Visszaadja a dokumentum XML azonosítóját (az Id attribútum tartalmát).

Visszatérési érték:

A dokumentum Object Id-ját tartalmazó string.

IDispatch * GetFirstRecipientCertificateItem();

A titkosított dokumentum első címzett tanúsítvány adatainak az interfészét tudjuk lekérni. A GetNextRecipientCertificateItem() metódussal együtt használva végigiterálhatunk az összes tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedCertificate interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextRecipientCertificateItem();

A titkosított dokumentum következő címzett tanúsítvány adatainak az interfészét tudjuk lekérni. A GetFirstRecipientCertificateItem() metódussal együtt használva végigiterálhatunk a dokumentumon lévő összes aláíráson és időbélyegen.

Visszatérési érték:

Egy IXSignAttachedCertificate interfészre mutató pointer. Sikertelen iteráció esetén, vagy ha nincs több címzett, akkor NULL a pointer értéke.

LONG GetMainType();

Visszaadja a dokumentum belső típusát

A visszatérési értékek a következők lehetnek:

• 0 - ismeretlen
• 4 - dokumentum
• 8 - megjegyzés dokumentum

IDispatch ** GetRecipientInfos();

Visszaadja a titkosított dokumentum cimzettjeinek adatait.

Visszatérési érték:

Egy IXSignRecipientInfos interfészre mutató pointer. Sikertelen iteráció esetén, vagy ha nincs több címzett, akkor NULL a pointer értéke.

LONG GetLastError();

Az utolsó művelet sikerességéről szóló információt kérhetjük le.

Visszatérési érték:

Az XSign legutóbbi visszatérési értéke (lásd XSign visszatérési értékek című alfejezet).

LONG Validate();

Az aláírás ellenőrzését végzi a metódus. Az ellenőrzés menete függ a IXSignSessionben beállított paraméterektől, így a visszavonás ellenőrzés módját és az esetleges hozzáférési információkat be kell állítani az IXSignSession interfészen keresztül. A funkció ellenőrzi az aláírás sértetlenségét, az aláírói tanúsítvány visszavonási állapotát és az aláíráson elhelyezett időbélyegeket is, tehát elvégzi a komplett aláírás ellenőrzést. Az ellenőrzés az időbélyegek esetén is hasonlóan történik. Az ellenőrzés során lehetőség van arra, hogy az aláírás típusát megváltoztassuk, kibővítsük visszavonási információkkal és időbélyegekkel. Akár alap aláírásból is készíthetünk archív aláírást, ehhez az IXSignSession interfészen keresztül be kell állítani a megfelelő paramétereket.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Érvényes aláírás esetén a visszatérési érték 0 (XSR_OK). Az XSR_INCOMPLETE_VALIDATION hibakód azt jelenti, hogy az ellenőrzés során a valamely tanúsítvány állapotát nem sikerült ellenőrizni. Ez nem jelenti azt, hogy az aláírás nem volt érvényes; ennek leggyakrabban az az oka, hogy egy tanúsítványhoz tartozó visszavonási információból nem áll rendelkezésre a legfrissebb verzió.

LONG Delete();

Törli az aktuális aláírást. A törlés után az aláírás objektum érvénytelen lesz és minden rajta végrehajtott művelet hibára fut.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetTitle();

Az adott aláírás címét, azaz az aláíró nevét adja vissza. Automata esetében is az automata aláírói tanúsítványban szereplő nevet adja meg a metódus.

Visszatérési érték:

Az aláíró nevét tartalmazó string.

LONG GetXadesType();

Az aláírás XAdES típusát adja vissza a metódus.

Visszatérési érték:

A XAdES típus, lehetséges értékei:

• 1 - XS_XADES_BES alap aláírás
• 2 - XS_XADES_EPES alap aláírás aláírási szabályzattal
• 3 - XS_XADES_T időbélyeges aláírás
• 4 - XS_XADES_C ellenőrzési adatok csatolása - ez a típus létrehozáskor ill. kibővítéskor nem adható meg!
• 5 - XS_XADES_X ellenőrzési adatok védelme időbélyeggel - ez a típus létrehozáskor ill. kibővítéskor nem adható meg!
• 6 - XS_XADES_X_L ellenőrzési adatok védelme időbélyeggel - ez a típus létrehozáskor ill. kibővítéskor nem adható meg!
• 7 - XS_XADES_A teljes aláírás védelme archív időbélyeggel

VARIANT_BOOL GetQualified();

Megadja, hogy az aláírói tanúsítvány minősített-e.

Visszatérési érték:

Boolean változó, melynek igaz értéke azt jelenti, hogy az aláíró tanúsítvány minősített. Hamis érték esetén nem minősített tanúsítvánnyal készült az aláírás.

BSTR GetCreationDate();

Az aláírás készítésének az időpontját adja meg.

Visszatérési érték:

Az aláírás készítésének időpontját tartalmazó string.

BSTR GetSignerAlternativeName();

Az aláíró alternatív nevét adja vissza a függvény.

Visszatérési érték:

Az aláíró alternatív nevét tartalmazó string.

BSTR GetCertificateInBase64();

Az aláírói tanúsítványt adja vissza base64 kódolt formában.

Visszatérési érték:

Az aláírói tanúsítványt base64 kódolt formában tartalmazó string.

BSTR GetFirstCertificateInBase64FromChain();

Az aláírói tanúsítványhoz tartozó lánc első elemét adja vissza base64 kódolt formában.

Visszatérési érték:

A tanúsítványláncban levő első tanúsítványt base64 kódolt formában tartalmazó string.

BSTR GetNextCertificateInBase64FromChain();

Az aláírói tanúsítványhoz tartozó lánc következő elemét adja vissza base64 kódolt formában.

Visszatérési érték:

A tanúsítványláncban levő következő tanúsítványt base64 kódolt formában tartalmazó string vagy null, ha a lánc végére értünk.

BSTR GetSignaturePolicy();

Az aláíráskor használt aláírási szabályzat URL-jét adja vissza a metódus.

Visszatérési érték:

Az aláírási szabályzat URL-jét tartalmazó string.

BSTR GetType();

Az aláírás típusát adja vissza szöveges formában.

Visszatérési érték:

Az aláírás típusát tartalmazó string.

IDispatch * GetFirstAttachedTSItem();

Az aláíráshoz tartozó első időbélyeg adatainak az interfészét tudjuk lekérni. A GetNextAttachedTSItem() metódussal együtt használva végigiterálhatunk az összes időbélyegen.

Visszatérési érték:

Egy IXSignAttachedTS interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedTSItem();

Az aláíráshoz tartozó következő időbélyeg adatainak az interfészét tudjuk lekérni. A GetFirstAttachedTSItem() metódussal együtt használva végigiterálhatunk az összes időbélyegen.

Visszatérési érték:

Egy IXSignAttachedTS interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetFirstAttachedCRLItem();

Az aláíráshoz tartozó első tanúsítvány visszavonási lista adatainak az interfészét tudjuk lekérni. A GetNextAttachedCRLItem() metódussal együtt használva végigiterálhatunk az összes tanúsítvány visszavonási listán.

Visszatérési érték:

Egy IXSignAttachedCRL interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedCRLItem();

Az aláíráshoz tartozó következő tanúsítvány visszavonási lista adatainak az interfészét tudjuk lekérni. A GetFirstAttachedCRLItem() metódussal együtt használva végigiterálhatunk az összes tanúsítvány visszavonási listán.

Visszatérési érték:

Egy IXSignAttachedCRL interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetFirstAttachedCertificateItem();

Az aláíráshoz tartozó első hitelesítés-szolgáltató tanúsítvány adatainak az interfészét tudjuk lekérni. A GetNextAttachedCertificateItem() metódussal együtt használva végigiterálhatunk az összes tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedCRL interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedCertificateItem();

Az aláíráshoz tartozó következő hitelesítés-szolgáltató tanúsítvány adatainak az interfészét tudjuk lekérni. A GetFirstAttachedCertificateItem() metódussal együtt használva végigiterálhatunk az összes tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedCertificate interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetFirstAttachedOCSPItem();

Az aláíráshoz tartozó első OCSP válasz adatainak az interfészét tudjuk lekérni. A GetNextAttachedOCSPItem() metódussal együtt használva végigiterálhatunk az összes OCSP válaszon.

Visszatérési érték:

Egy IXSignAttachedOCSP interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedOCSPItem();

Az aláíráshoz tartozó következő OCSP válasz adatainak az interfészét tudjuk lekérni. A GetFirstAttachedOCSPItem() metódussal együtt használva végig iterálhatunk az összes OCSP válaszon.

Visszatérési érték:

Egy IXSignAttachedOCSP interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetFirstAttachedAttributeCertificateItem();

Az aláíráshoz tartozó első csatolt attribútum tanúsítvány adatainak az interfészét tudjuk lekérni. A GetNextAttachedAttributeCertificateItem() metódussal együtt használva végigiterálhatunk az összes csatolt attribútum tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedAttributeCertificate interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedAttributeCertificateItem();

Az aláíráshoz tartozó következő csatolt attribútum tanúsítvány adatainak az interfészét tudjuk lekérni. A GetFirstAttachedAttributeCertificateItem() metódussal együtt használva végig iterálhatunk az csatolt attribútum tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedAttributeCertificate interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetCustomMetadata();

Az aláíráshoz tartozó metaadatokat kérhetjük le.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Visszatérési érték:

A metaadatokhoz tartozó IXSignMetadataMap interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az egyes név-érték párokat. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetCommentDocument();

Az elektronikus aláíráshoz csatolt dokumentumot adja vissza.

Visszatérési érték:

A dokumentumhoz tartozó IXSignCommentDocument interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az dokumentumhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * GetFirstReference();

Ezzel a függvénnyel az aláírás által aláírt első adat (Reference elem) információit lehet lekérdezni.

Visszatérési érték:

Egy IXSignSignatureReference interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextReference();

Ezzel a függvénnyel az aláírás által aláírt következő adat (Reference elem) információit lehet lekérdezni. A GetFirstReference() metódussal együtt használva végigiterálhatunk az összes referencián.

Visszatérési érték:

Egy IXSignSignatureReference interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

BSTR GetUnsignedHash();

Ez a metódus a félig kész aláírásból kinyeri az aláíratlan lenyomatot.

Az elosztott aláírás készítés részleteiről a IXSignDossier::SetSignedHash() függvény leírásában olvashat.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Visszatérési érték:

A base64 kódolt aláíratlan lenyomatot tartalmazó string.

LONG SetSignedHash(BSTR hash);

Ez a metódus a félig kész aláírásba helyezi az aláírt lenyomatot.

Az elosztott aláírás készítés részleteiről a IXSignDossier::SetSignedHash() függvény leírásában olvashat.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Paraméterek:

• BSTR hash – Bemeneti paraméter. A base64 kódolt aláírt lenyomat.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG GetMainType();

Visszaadja az aláírás belső típusát

A visszatérési értékek a következők lehetnek:

• 0 - ismeretlen
• 5 - időbélyeg
• 7 - aláírás
• 14 - ellenjegyzés

BSTR GetIdentifier();

Visszaadja az aláírás azonosítóját.

Visszatérési érték:

Az aláírás azonosítóját tartalmazó string.

BSTR GetSignerRole();

Visszaadja az aláíró szerepét.

Visszatérési érték:

Az aláíró szerepét tartalmazó string.

BSTR GetSignerApplication();

Visszaadja az aláíró alkalmazás nevét.

Visszatérési érték:

Az aláíró alkalmazás nevét tartalmazó string.

BSTR GetSignatureAlgorithm();

Visszaadja az aláíró algoritmus nevét.

Visszatérési érték:

Az aláíró algoritmus nevét tartalmazó string.

BSTR GetSignatureKeyDescription();

Visszaadja az aláíró kulcs leírását szöveges formában.

Visszatérési érték:

Az aláíró kulcs leírását tartalmazó string.

BSTR GetCertSignAlgorithm();

Visszaadja az aláíró tanúsítvány aláírásához használt algoritmus nevét.

Visszatérési érték:

Az aláíró tanúsítvány aláírásához használt algoritmus nevét tartalmazó string.

BSTR GetXAdESVersion();

Visszaadja, hogy az aláírás melyik XAdES verziónak felel meg.

Visszatérési érték:

A XAdES verziót jelentő string, ld. IXSignSession::SetXAdESVersion().

BSTR GetAfterFirstValidationTime();

E metódus visszaadja az aláírás első ellenőrzése utáni megbízható időpontot (a *RefsTimeStamp elem alapján).

Visszatérési érték:

Az aláírás első ellenőrzése utáni megbízható időpontot tartalmazó string.

BSTR GetLastArchiveTSTime();

E metódus visszaadja az utolsó archív időbélyeg időpontját.

Visszatérési érték:

Az utolsó archív időbélyeg időpontját tartalmazó string.

BSTR GetLastArchiveTSValidityEnd();

E metódus visszaadja az utolsó archív időbélyegző tanúsítványának lejárati időpontját.

Visszatérési érték:

Az utolsó archív időbélyegző tanúsítványának lejárati időpontját tartalmazó string.

IDispatch * GetSignProperties();

E metódus visszaadja az aláíráshoz tartozó tovább aláírói tulajdonságokat egy IXSignSignProperties objektumban.

Visszatérési érték:

IXSignSignProperties objektum

VARIANT_BOOL IsDocumentSafeViewed();

E metódus visszaadja, hogy az aláíró az aláírt dokumentumot biztonságos megjelenítővel tekintette-e meg.

Visszatérési érték:

VARIANT_TRUE, amennyiben az aláíró az aláírt dokumentumot biztonságos megjelenítővel tekintette meg, egyébként VARIANT_FALSE.

VARIANT_BOOL IsDocumentSignedByAServer();

E metódus visszaadja, hogy az aláírást automata készítette-e.

Visszatérési érték:

VARIANT_TRUE, amennyiben az aláírást automata készítette, egyébként VARIANT_FALSE.

IDispatch * GetQCResult();

E metódus az aláírói tanúsítvány minősítéséről ad hasznos információt egy IXSignQCResult interfésszel lekérdezhető objektumban

Visszatérési érték:

IXSignQCResult objektum

BSTR GetOrganizationIdentifier();

E metódus visszaadja, aláírói tanúsítvány szervezeti azonosítóját.

Visszatérési érték:

Az aláírói tanúsítvány szervezeti azonosítóját tartalmazó string.

LONG GetLastError();

Az utolsó művelet sikerességéről szóló információt kérhetjük le.

Visszatérési érték:

Az XSign legutóbbi visszatérési értéke (lásd XSign visszatérési értékek című alfejezet).

LONG Save(BSTR commentDocumentPath);

Az elektronikus aláíráshoz csatolt dokumentumot ki lehet menteni a fájlrendszerbe a megadott névre.

Paraméterek:

• BSTR commentDocumentPath – Bemeneti paraméter. A mentés helyét kell megadni ebben a paraméterben teljes vagy relatív elérési úttal.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetTitle();

Az adott dokumentum címét adja vissza a metódus.

Visszatérési érték:

A dokumentum címét tartalmazó string.

BSTR GetMIMEType();

Az adott dokumentum MIME típusát adja vissza.

Visszatérési érték:

A dokumentum MIME típusát tartalmazó string.

BSTR GetExtension();

A dokumentum eredeti fájlkiterjesztését kérhetjük le.

Visszatérési érték:

A dokumentum kiterjesztését tartalmazó string.

LONG GetLastError();

Az utolsó művelet sikerességéről szóló információt kérhetjük le.

Visszatérési érték:

LONG Save(BSTR dossierPath);

Az XML-t elmenti a fájlrendszerbe a dossierPath paraméterben megadott elérési útra a megadott névvel.

Paraméterek:

• BSTR dossierPath – Bemeneti paraméter. A mentendő fájl nevét kell megadni teljes vagy relatív elérési úttal.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG InsertDocument(BSTR sURL, BSTR sMIMEType);

Egy megadott URL-en lévő fájlt fog beilleszteni az aláírandó fájlok listájába. A modul fájlrendszerből és HTTP csatornán keresztül képes fájlokat különálló aláírással ellátni. Az aláírás a következő Sign() híváskor készül el – ekkor törlődik az aláírandó fájlok listája.

Paraméterek:

• BSTR dossierPath – Bemeneti paraméter. A fájl URL-je.
• BSTR sMIMEType – Bemeneti paraméter. A fájl MIME-típusa.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG Sign(BSTR xpath, LONG insertAs, BYTE addSchemaLocation);

Elkészíti az XML aláírást a korábban „beillesztett” fájlokra (InsertDocument() esetén különálló, AddTBSObject() esetén pedig beágyazott aláírás készül). Az elkészülő aláírás típusa függ az IXSignSession felületen keresztül beállított paraméterek értékeitől.

Megjegyzés:

Windows CE operációs rendszer alatt nem támogatott ez a funkció.

Paraméterek:

• BSTR xpath – Különálló aláírás esetén értelmezett opcionális bemeneti paraméter. Ez az XPath kifejezés adja meg, hogy az aláírás hová kerüljön az XML-be. Alapértelmezett értéke az üres string.
• LONG insertAs – Különálló aláírás esetén értelmezett opcionális bemeneti paraméter. A beillesztendő aláírás helyét az xpath paraméterrel együtt határozza meg. Jelentése:
  • 0 – az XPathszal megadott hely első gyerekelemeként kerül beszúrásra az aláírás.
  • 1 – az XPathszal megadott helyet megelőző helyre kerül beillesztésre az aláírás.
• BYTE addSchemaLocation – Különálló aláírás esetén értelmezett opcionális bemeneti paraméter. Boolean változó, melynek igaz értéke esetén a schemaLocation hozzáadódik a beillesztett Signature elemhez. Alapértelmezett értéke: hamis.

Alapértelmezett értéke 0.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

VARIANT_BOOL IsSigned();

A nem e-akta típusú XML-ről megmondja, hogy alá van-e írva. (Különálló aláírás készítésekor ezen hívás megmondja, hogy az InsertDocument() hívásokat követte-e már Sign() hívás.)

Visszatérési érték:

Boolean változó melynek igaz értéke azt jelenti, hogy az XML alá van írva, hamis értéke pedig azt, hogy nincs aláírva.

LONG AddTBSObject(BSTR uri, LONG transform, BSTR mimeType);

Beágyazott XML aláírás készítésekor e metódus segítségével tölthetjük fel az aláírandó XML elemek listáját – egy AddTBSObject() hívás egy elemet ad ehhez a listához. Az aláírás a következő Sign() híváskor készül el – ekkor törlődik az aláírandó XML elemek listája.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a függvény.

Paraméterek:

• BSTR uri – Az aláírandó XML elem URI-ja. Csak az Id alapú (#Id formátumú) belső URI-k támogatottak.
• LONG transform – Az XML elemen aláíráskor elvégzendő transzformáció. Lehetséges értékei:
  • 0 – XML kanonizálás. Az XML elem teljes forrása (befoglaló címkékkel együtt) aláírásra kerül.
  • 1 – Base64 dekódolás. Csak az XML elembe ágyazott base64 kódolt tartalom kerül aláírásra, a címkék nem.
• BSTR mimeType – Base64 kódolt tartalom esetén értelmezett opcionális bemeneti paraméter. Az aláírt tartalom MIME-típusa adható meg vele.

Visszatérési érték:

LONG RegisterXPathNS (BSTR prefix, BSTR href);

XML-be illesztendő aláírás létrehozása előtt ezen függvény használatával regisztrálhatjuk be az aláíráskor megadandó XPath kifejezésben használt XML névtér prefixeket.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a függvény.

Paraméterek:

• BSTR prefix – Az XML névtér prefix.
• BSTR href – Az XML névtér URI (HREF).

Visszatérési érték:

VARIANT GetSource();

Visszaadja az XML forrását.

Visszatérési érték:

Az XML forrása bájtsorozatként, SAFEARRAY tömbben.

IDispatch * GetFirstSignature();

Az XML-ben található első aláírást adja vissza. Az IXSignForeignDossier::GetNextSignature() metódus segítségével végigiterálhatunk az XML-ben szereplő aláírásokon.

Visszatérési érték:

Az első aláíráshoz tartozó IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén, vagy ha nincs aláírás az XML-ben, akkor NULL a pointer értéke.

IDispatch * GetNextSignature();

Az XML-ben található következő aláírást adja vissza. Az IXSignForeignDossier::GetFirstSignature() metódussal együtt használva végigiterálhatunk az XML-ben szereplő összes aláíráson

Visszatérési érték:

Az aláíráshoz tartozó IXSignSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen iteráció esetén vagy ha nincs több aláírás, akkor NULL a pointer értéke.

LONG AddToURLCache(BSTR sURL, VARIANT* data);

E függvény használható az XSign4COM URL gyorsítótárának (cache) feltöltésére, ezáltal lehetőség van aktuálisan nem elérhető, de előzetesen beszerzett online tartalmak offline aláírására is. Amennyiben az XSign4COM az aktuális akta feldolgozásakor (pl. aláírás készítésekor) olyan URL-lel találkozik, amely szerepel a cache-ben, nem próbál meg hozzákapcsolódni, hanem a megadott bájtsorozatot fogja az URL tartalmaként használni. Az URL cache aktához („foreign dossier”) tartozik.

Paraméterek:

• BSTR sURL – A megadandó URL string formátumban.

VARIANT* data – Az URL tartalma bájtsorozatként, SAFEARRAY tömbben (VT_ARRAY | VT_UI1 típussal).

Visszatérési érték:

LONG SetBaseURI(BSTR sURL, LONG* pRetVal);

Ha az ForeignDossier osztály insertDocument metódus segítségével relatív URI megadásával szeretnénk dokumentumot beilleszteni, akkor előtte be kell állítanunk az alap URI-t. Erre szolgál ez a metódus.

Paraméterek:

• BSTR sURL – A megadandó URL string formátumban.

Visszatérési érték:

LONG ClearURLCache();

Kiüríti az URL gyorsítótárat, amit az AddToURLCache() metódussal feltöltöttünk. Memóriahasználat szempontjából lehet jelentősége.

Visszatérési érték:

LONG Free();

Felszabadítja az XML aláírással kapcsolatos memóriaterületeket az XSign DLL-en belül. Figyelem! A függvény hatására az XML aláírást szimbolizáló XSignForeignDossier objektum használhatatlanná válik. Metódusai meghívása nem definiált működéshez vezet!

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SignWithProperties(BSTR signaturePolicyURL, BSTR signaturePlacePostalCode, BSTR signaturePlaceSettlement, BSTR signaturePlaceProvince, BSTR signaturePlaceCountry, BSTR signerRole, BSTR commitmentType, BSTR xpath, LONG insertAs, BYTE addSchemaLocation);

Elkészíti az XML aláírást a korábban „beillesztett” fájlokra (InsertDocument() esetén különálló, AddTBSObject() esetén pedig beágyazott aláírás készül). Aláíráskor megadható számos az aláírás körülményével kapcsolatos adat, így például: aláírási szabályzat, aláírás helye, aláíró szerepe, stb. Az elkészülő aláírás típusa függ az IXSignSession felületen keresztül beállított paraméterek értékeitől.

Megjegyzés:

Windows CE operációs rendszer alatt nem támogatott ez a funkció.

Paraméterek:

• BSTR signaturePolicyURL – Bemeneti paraméter. Az aláírási szabályzat URI-ja. Nincs alapértelmezett értéke.
• BSTR signaturePlacePostalCode – Bemeneti paraméter. Az aláírás helye: irányítószám. Nincs alapértelmezett értéke.
• BSTR signaturePlaceSettlement – Bemeneti paraméter. Az aláírás helye: város. Nincs alapértelmezett értéke.
• BSTR signaturePlaceProvince – Bemeneti paraméter. Az aláírás helye: megye. Nincs alapértelmezett értéke.
• BSTR signaturePlaceCountry – Bemeneti paraméter. Az aláírás helye: ország. Nincs alapértelmezett értéke.
• BSTR signerRole – Bemeneti paraméter. Az aláaró szerepe. Nincs alapértelmezett értéke.
• BSTR commitmentType – Bemeneti paraméter. Az aláíró kötelezettség-vállalása. Nincs alapértelmezett értéke. A XAdES szabvány szerinti lehetséges értékei:
  • http://uri.etsi.org/01903/v1.2.2#ProofOfOrigin – eredet igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfReceipt – átvételi elismervény
  • http://uri.etsi.org/01903/v1.2.2#ProofOfDelivery – kézbesítés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfSender – elküldés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfApproval – jóváhagyás
  • http://uri.etsi.org/01903/v1.2.2#ProofOfCreation – létrehozás igazolása
• BSTR xpath – Különálló aláírás esetén értelmezett opcionális bemeneti paraméter. Ez az XPath kifejezés adja meg, hogy az aláírás hová kerüljön az XML-be. Alapértelmezett értéke az üres string.
• LONG insertAs – Különálló aláírás esetén értelmezett opcionális bemeneti paraméter. A beillesztendő aláírás helyét az xpath paraméterrel együtt határozza meg. Jelentése:
  • 0 – az XPathszal megadott hely első gyerekelemeként kerül beszúrásra az aláírás.
  • 1 – az XPathszal megadott helyet megelőző helyre kerül beillesztésre az aláírás.
• BYTE addSchemaLocation – Különálló aláírás esetén értelmezett opcionális bemeneti paraméter. Boolean változó, melynek igaz értéke esetén a schemaLocation hozzáadódik a beillesztett Signature elemhez. Alapértelmezett értéke: hamis.

Alapértelmezett értéke 0.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetValue(BSTR key);

A megadott kulcs alapján visszakapjuk a hozzá tartozó metaadat értéket.

Visszatérési érték:

Az értéket tartalmazó string. Amennyiben a megadott kulcshoz nincs megfelelő érték, akkor üres stringgel tér vissza a metódus.

VARIANT GetKeys();

Az összes metaadathoz tartozó kulcsot adja vissza a függvény egy listában.

Visszatérési érték:

Metaadat kulcsokat tartalmazó lista (SAFEARRAY). Üres lista a visszatérési érték, ha nem volt metaadat vagy sikertelen volt a lekérdezés.

void PutKeyAndValue(BSTR key, BSTR value);

Ezen metódus segítségével adhatunk hozzá metaadatot az aktához.

Paraméterek:

• BSTR key – Bemeneti paraméter. A kulcs értéke.
• BSTR value – Bemeneti paraméter. Az a metaadat, amit a key paraméterben megadott kulcshoz szeretnénk rendelni.

BSTR GetValue(BSTR key);

A megadott kulcs alapján visszakapjuk a hozzá tartozó metaadat értéket.

Visszatérési érték:

Az értéket tartalmazó string. Amennyiben a megadott kulcshoz nincs megfelelő érték, akkor üres stringgel tér vissza a metódus.

VARIANT GetKeys();

Az összes metaadathoz tartozó kulcsot adja vissza a függvény egy listában.

Visszatérési érték:

Metaadat kulcsokat tartalmazó lista (SAFEARRAY). Üres lista a visszatérési érték, ha nem volt metaadat vagy sikertelen volt a lekérdezés.

void Add(BSTR key, BSTR value);

Új metaadat hozzáadása.

Paraméterek:

• BSTR key – Bemeneti paraméter. A kulcs értéke.
• BSTR value – Bemeneti paraméter. Az a metaadat, amit a key paraméterben megadott kulcshoz szeretnénk rendelni.

BSTR GetTimeString();

Az időbélyeg dátumát kérdezhetjük le.

Visszatérési érték:

Az időbélyeg dátumát tartalmazó string.

BSTR GetSerialNumber();

Az időbélyeg sorozatszámát kérdezhetjük le.

Visszatérési érték:

Az időbélyeg sorozatszámát tartalmazó string.

LONG GetAccuracyS();

Az időbélyeg szolgáltató pontosságát kérdezhetjük le.

Visszatérési érték:

Az időbélyeg szolgáltató pontosságát tartalmazó érték másodpercben megadva.

LONG GetAccuracyMS();

Az időbélyeg szolgáltató pontosságát kérdezhetjük le.

Visszatérési érték:

Az időbélyeg szolgáltató pontosságát tartalmazó érték ezred másodperben megadva.

LONG GetAccuracyUS();

Az időbélyeg szolgáltató pontosságát kérdezhetjük le.

Visszatérési érték:

Az időbélyeg szolgáltató pontosságát tartalmazó érték mikroszekundumban megadva.

LONG GetVersion();

Az időbélyeg protokoll verziószámát adja vissza.

Visszatérési érték:

Az időbélyeg protokoll verziószáma.

BSTR GetHashAlgorithm();

Az időbélyegzés során használt lenyomatképző algoritmus megnevezését adja vissza a metódus.

Visszatérési érték:

A lenyomatképző algoritmus megnevezése string formában.

BSTR GetItemName();

Az időbélyeget tartalmazó XML elem nevét adja vissza.

Visszatérési érték:

Az időbélyeget tartalmazó XML elem neve string formátumban.

BSTR GetStatusText();

Az időbélyeg kérésre adott válasz státuszát adja meg a metódus.

Visszatérési érték:

Az időbélyeg státuszát tartalmazó string.

BSTR GetNonce();

Az időbélyeg kérés session azonosítóját adja vissza. Ezt az értéket az RFC 3161 definiálja.

Visszatérési érték:

Session azonosító string.

BSTR GetPolicyIdentifier();

Az időbélyegzési szabályzat azonosítóját adja vissza.

Visszatérési érték:

Szabályzatot azonosító string.

BSTR GetMessageImprint();

Az időbélyegben szereplő lenyomatot adja vissza hexadecimális formában. Az IXSignAttachedTS::GetHashAlgorithm() függvénnyel olvashatjuk ki, hogy milyen algoritmussal készült a lenyomat.

Visszatérési érték:

Lenyomatot tartalmazó string.

VARIANT GetTSACertificateInDER();

Az időbélyeg-szolgáltató ASN.1 DER kódolt tanúsítványát adja vissza.

Visszatérési érték:

A tanúsítványt tartalmazó byte tömb (SAFEARRAY).

VARIANT GetCRLInDER();

Az adott tanúsítvány visszavonási listát adja vissza ASN.1 DER kódolt formában.

Visszatérési érték:

A CRL-t tartalmazó byte tömb (SAFEARRAY).

BSTR GetSubjectCN();

A kiválasztott tanúsítványban szereplő tulajdonosi CN (Common Name) mező tartalmát adja vissza.

Visszatérési érték:

A CN-t tartalmazó string.

BSTR GetSubjectDN();

A kiválasztott tanúsítványban szereplő tulajdonosi DN (Distinguished Name) mező tartalmát adja vissza.

Visszatérési érték:

A DN-t tartalmazó string.

BSTR GetEmailAddress();

A kiválasztott tanúsítványban szereplő tulajdonosi e-mail címet adja vissza.

Visszatérési érték:

Az e-mailt tartalmazó string.

VARIANT GetCertificateInDER();

Az adott tanúsítványt ASN.1 DER kódolt formában adja vissza.

Visszatérési érték:

A DER kódolt tanúsítványt tartalmazó byte tömb (SAFEARRAY).

ULONG GetCount();

A kiválasztott titkosított dokumentum cimzettjeinek számát adja meg.

Visszatérési érték:

A dokumentum cimzettjeinek száma.

BSTR* GetCertificate();

Az adott címzett tanúsítványát base64 kódolt formában adja vissza.

Visszatérési érték:

Az adott címzett tanúsítványát base64 kódolva.

BSTR GetEncodedKey();

Az adott címzett privát kulcsát base64 kódolt formában adja vissza.

Visszatérési érték:

Az adott címzett privát kulcsát base64 kódolva.

LONG GetVersion();

Az OCSP válasz verzióját adja meg.

Visszatérési érték:

A verzió információt tartalmazó szám.

BSTR GetCertificateSubjectCN();

Az OCSP válaszadó tanúsítványában szereplő tulajdonosi CN (Common Name) mező értékét adja vissza.

Visszatérési érték:

A CN-t tartalmazó string.

BSTR GetProducedAt();

A metódus az OCSP válasz létrehozásának időpontját adja meg szöveges formában.

Visszatérési érték:

Az időpontot tartalmazó string.

BSTR GetResponderIdentifier();

Az OCSP válaszadó egyedi azonosítóját (DN) adja meg.

Visszatérési érték:

Az egyedi azonosítót tartalmazó string.

Például: „CN=Microsec e-Szigno Test OCSP Responder, OU=e-Szigno CA, O = Microsec Ltd., L=Budapest, C=HU”.

BSTR GetResponseStatus();

A metódus az OCSP válasz státuszát adja vissza szöveges formában.

Visszatérési érték:

Az státusz információt tartalmazó string.

BSTR GetResponseType();

Az OCSP válasz típusát adja meg.

Visszatérési érték:

A típust tartalmazó string.

BSTR GetSignature();

Az OCSP válaszon lévő aláírást adja vissza hexadecimális formában.

Visszatérési érték:

Az aláírás string formátumban.

VARIANT GetCertificateInDER();

Az OCSP válaszadó ASN.1 DER formátumban kódolt tanúsítványát adja vissza.

Visszatérési érték:

A DER kódolt tanúsítványt tartalmazó byte tömb (SAFEARRAY).

IDispatch * GetOCSPSingleResponseAt();

Az egy OCSP tranzakcióban kapott egyedi OCSP válaszokhoz tartozó IXSignOCSPSingleResponse típusú interfészeket kérhetjük le a metódus segítségével. A több OCSP válasz közül egy index segítségével választhatunk. Ld. még GetOCSPSingleResponseSize().

Paraméterek:

• LONG index – A kiválasztani kívánt egyedi OCSP válasz indexe.

Visszatérési érték:

Az IXSignOCSPSingleResponse felületre mutató pointer címe, hiba esetén a pointer értéke NULL.

IDispatch * GetExtensionAt(LONG index );

Az egy OCSP tranzakcióban kapott egyedi OCSP válaszokhoz tartozó IXSignExtension típusú interfészeket kérhetjük le a metódus segítségével. A több kiterjesztés közül egy index segítségével választhatunk.

Paraméterek:

• LONG index – A kiválasztani kívánt OCSP kiterjesztés indexe.

Visszatérési érték:

Az IXSignExtension felületre mutató pointer címe, hiba esetén a pointer értéke NULL.

LONG GetOCSPSingleResponseSize();

Az egy OCSP tranzakcióban kapott egyedi OCSP válaszok számát adja vissza.

Visszatérési érték:

Az egyedi OCSP válaszok száma.

LONG GetExtensionSize();

Az egy OCSP tranzakcióban kapott kiterjesztések számát adja vissza.

Visszatérési érték:

Az egyedi OCSP válaszok száma.

LONG GetVersion();

A csatolt attribútum tanúsítvány verzióját adja meg.

Visszatérési érték:

A verzió információt tartalmazó szám.

BSTR GetIssuer();

A csatolt attribútum tanúsítvány tulajdonosának kibocsájtóját adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány tulajdonosának kibocsájtóját tartalmazó string.

BSTR GetSerial();

A csatolt attribútum tanúsítvány tulajdonosának sorozatszámát adja meg hexadecimális formában.

Visszatérési érték:

A csatolt attribútum tanúsítvány tulajdonosának sorozatszámát hexadecimális formában tartalmazó string.

BSTR GetIssuerUID();

A csatolt attribútum tanúsítvány tulajdonosának kibocsájtója által adott egyedi azonosítót adja meg hexadecimális formában.

Visszatérési érték:

A csatolt attribútum tanúsítvány tulajdonosának kibocsájtója által adott egyedi azonosítót hexadecimális formában tartalmazó string.

BSTR GetEntityName();

A csatolt attribútum tanúsítvány tulajdonosának entitásnevét adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány tulajdonosának entitásnevét tartalmazó string.

ULONG GetDigestObjectType();

A a csatolt attribútum tanúsítvány tulajdonos meghatározásához hash-elt objektumának típusát adja vissza.

Visszatérési érték:

• 0 - nyilvános kulcs
• 1 - nyilvános kulcsú tanúsítvány
• 2 - egyéb típus (version = 2 esetén nem használható)
• 0xffffffff - ismeretlen

BSTR GetDigestAlgorithm();

A csatolt attribútum tanúsítvány tulajdonos meghatározásához használt hash algoritmusát adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány tulajdonos meghatározásához használt hash algoritmusát tartalmazó string.

BSTR GetObjectDigest();

A csatolt attribútum tanúsítvány tulajdonos meghatározásához használt hash-t adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány tulajdonos meghatározásához használt hash-t tartalmazó string.

BSTR GetIssuerName();

A csatolt attribútum tanúsítvány kibocsátójának nevét adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány kibocsátójának nevét tartalmazó string.

BSTR GetSerialNumber();

A csatolt attribútum tanúsítvány sorozatszámát adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány sorozatszámát tartalmazó string.

BSTR GetNotBefore();

A csatolt attribútum tanúsítvány érvényességének kezdetét adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány érvényességének kezdetét tartalmazó string.

BSTR GetNotAfter();

A csatolt attribútum tanúsítvány érvényességének végét adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány érvényességének végét tartalmazó string.

BSTR GetSignature();

A csatolt attribútum tanúsítvány aláírásának algoritmusát (AttributeCertificateInfo) adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány aláírásának algoritmusát (AttributeCertificateInfo) tartalmazó string.

BSTR GetSignatureAlgorithm();

A csatolt attribútum tanúsítvány aláírásának algoritmusát (AttributeCertificate) adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány aláírásának algoritmusát (AttributeCertificate) tartalmazó string.

BSTR GetSignatureValue();

A csatolt attribútum tanúsítvány aláírásának értékét (AttributeCertificate) adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány aláírásának értékét (AttributeCertificate) tartalmazó string.

VARIANT GetAttributeRoleNames();

A csatolt attribútum tanúsítvány által tanúsított szerepek listája (stringeket tartalmazó SAFEARRAY formában) adja vissza.

Visszatérési érték:

A csatolt attribútum tanúsítvány által tanúsított szerepek listáját stringekként tartalmazó SAFEARRAY.

VARIANT GetRoleAuthoritiesForRoleName(BSTR roleName);

A szerep tanusítóinak listáját (stringeket tartalmazó SAFEARRAY formában) adja vissza.

Paraméter:

• BSTR roleName – a GetAttributeRoleNames() által visszaadott egyik szerep neve.

Visszatérési érték:

A szerep tanusítóinak listáját stringekként tartalmazó SAFEARRAY.

VARIANT_BOOL IsNotGood();

A kérdezett tanúsítvány „jó” állapotát jelzi.

Visszatérési érték:

Boolean változó, igaz érték esetén a kérdezett tanúsítvány nem érvényes (visszavonták, felfüggesztették), hamis érték esetén jó a tanúsítvány.

BSTR GetCertificateStatus();

A kérdezett tanúsítvány állapotát adja vissza szöveges formátumban.

Visszatérési érték:

A tanúsítvány állapota szöveges formában.

BSTR GetCurrentUpdate();

A válasz érvényességének a kezdetét (thisUpdate) adja meg.

Visszatérési érték:

Az érvényesség kezdetét jelző időpontot tartalmazó string.

BSTR GetNextUpdate();

A válasz érvényességének a végét (nextUpdate) adja meg.

Visszatérési érték:

Az érvényesség végét jelző időpontot tartalmazó string.

BSTR GetHashAlgorithm();

A használt lenyomatképző algoritmus nevét adja vissza.

Visszatérési érték:

A lenyomatképző algoritmus nevét tartalmazó string.

BSTR GetIssuerKeyHash();

A kérdezett tanúsítványt kibocsátó hitelesítés-szolgáltató nyilvános kulcsának lenyomata hexadecimális formában.

Visszatérési érték:

A kulcs lenyomatát tartalmazó string.

BSTR GetIssuerNameHash();

A kérdezett tanúsítványt kibocsátó hitelesítés-szolgáltató DN-jének lenyomata.

Visszatérési érték:

A DN lenyomatát tartalmazó string.

BSTR GetSerialNumber();

A kérdezett tanúsítvány sorozatszáma hexadecimális formában.

Visszatérési érték:

A sorozatszámot tartalmazó string.

LONG GetExtensionSize();

Az egyedi OCSP válaszhoz tartozó kiterjesztések számát adja vissza. Ld. még GetExtensionAt().

Visszatérési érték:

A kiterjesztések száma.

IDispatch * GetExtensionAt(LONG index);

Az egyedi OCSP válaszokhoz tartozó IXSignExtension típusú interfészeket kérhetjük le a metódus segítségével. A több kiterjesztés közül egy index segítségével választhatunk. Ld. még GetExtensionSize().

Paraméter:

• LONG index – A kiválasztani kívánt OCSP kiterjesztés indexe.

Visszatérési érték:

Az IXSignExtension felületre mutató pointer címe, hiba esetén a pointer értéke NULL.

VARIANT_BOOL GetCriticality();

Megadja, hogy az adott kiterjesztés kritikus-e.

Visszatérési érték:

Boolean változó, igaz érték esetén a kiterjesztés kritikus.

BSTR GetOID();

Az adott kiterjesztés OID-jét adja vissza.

Visszatérési érték:

Az OID-et tartalmazó string.

BSTR GetName();

Az adott kiterjesztés nevét adja vissza.

Visszatérési érték:

A nevet tartalmazó string.

BSTR GetValue();

Az adott kiterjesztés értékét adja vissza.

Visszatérési érték:

Az értéket tartalmazó string.

LONG Save([in] BSTR path);

Elmenti a PDF dokumentumot a megadott elérési útra.

Paraméter:

• BSTR path – Bemeneti paraméter. Az elmentendő PDF elérési útja.

Visszatérési érték:

IDispatch * Sign([in, defaultvalue(20480)] LONG preserveSize);

Aláírja a PDF dokumentumot és visszatér az újonnan létrehozott PDF aláírás objektummal. Ha a visszavonás-ellenőrzési mód nincs megadva, OCSP/CRL-t használ.

Paraméter:

• LONG preserveSize – Bemeneti paraméter, opcionális. A PDF dokumentumban az aláírás számára szabadon hagyandó hely mérete bájtokban. Alapértelmezett értéke 20480 (20 KB).

Visszatérési érték:

Egy IXSignPDFSignature interfészre mutató pointer. Sikertelen aláírás esetén NULL a pointer értéke.

LONG Free();

Felszabadítja a PDF dokumentum objektummal kapcsolatos memóriaterületeket az XSign DLL-en belül. Figyelem! A függvény hatására mind a PDF-et szimbolizáló XSignPDFDocument, mind az abban található aláírásokat jelentő XSignPDFSignature objektumok használhatatlanná válnak. Metódusaik meghívása nem definiált működéshez vezet!

Visszatérési érték:

VARIANT Verify([in, defaultvalue(FALSE)] VARIANT_BOOL ignoreUnknownSubFilters);

Ellenőrzi a PDF dokumentumban lévő aláírásokat, és visszatér az ellenőrzött PDF aláírás objektumok listájával egy SAFEARRAY formájában. Megadható, hogy mit tegyen abban az esetben, ha ismeretlen subFilter értékkel találkozik. Az XSign4COM a leggyakrabban előforduló subFiltereket ismeri, nevezetesen:

• adbe.pkcs7.detached
• adbe.pkcs7.sha1
• ETSI.CAdES.detached

Paraméter:

• VARIANT_BOOL ignoreUnknownSubFilters – Amennyiben értéke TRUE, az XSign4COM átlépi az ismeretlen subFilter értékkel rendelkező aláírásokat, tehát nem is rakja bele a kimeneti tömbbe azokat. A FALSE érték esetén hibát jelez ismeretlen subFilter esetén.

Visszatérési érték:

Az ellenőrzött aláírás objektumok listája egy IDispatch* pointereket tartalmazó SAFEARRAY tömb formájában. Amennyiben az XSign4COM hibás aláírást talált, a visszatérési érték egy VT_EMPTY (üres) típusú VARIANT. Az XSign hibakódot az IXSignPDFDocument::GetLastError() meghívásával kaphatjuk meg.

LONG GetLastError();

Az utolsó művelet sikerességéről szóló információt kérhetjük le.

Visszatérési érték:

Az XSign legutóbbi visszatérési értéke (lásd XSign visszatérési értékek című alfejezet).

VARIANT GetSignatures();

Visszatérési érték:

Az aláírás objektumok listája egy IDispatch* pointereket tartalmazó SAFEARRAY tömb formájában. Az XSign hibakódot az IXSignPDFDocument::GetLastError() meghívásával kaphatjuk meg.

LONG SetImg([in] BSTR path);

Látható PDF aláírás létrehozásakor megadható kép fájl elérési útja, amelyet elhelyezhetünk a PDF dokumentum törzsében. A megadott képfájlnak a következő kép formátumok egyikének kell megfelelnie: png,jpg,tif. Ez a beállítás felülbírálja a korábban SetPDFSignImg -val beállított értéket.

Paraméter:

• BSTR path - Elérési út.

Visszatérési érték:

LONG SetImgPage([in] LONG pageno);

Megadható, hogy a látható PDF aláírást melyik oldalán helyezzük el a dokumentumnak. Alapértelmezett értéke: 1 – amely a dokumentum legelső oldalát jelenti. A dokumentum oldalainak számánál nagyobb érték esetén is az alapértelmezett értéket veszi fel. Ha az értéke -1 akkor az utolsó oldalt jelenti. Ez a beállítás felülbírálja a korábban SetPDFSignImgPage -val beállított értéket.

Paraméter:

• LONG pageno – Oldal száma.

Visszatérési érték:

LONG SetImgAlign([in] LONG align);

A látható PDF aláírás igazítása a megadott sarokba. Ez a beállítás felülbírálja a korábban SetPDFSignImgAlign-nal beállított értéket.

Paraméter:

• LONG align - A lap sarkának azonosítója.

  Lehetséges értékei:

  • 0 - SIG_RIGHT_TOP Igazítás a jobb felső sarokba.
  • 1 - SIG_RIGHT_BOTTOM Igazítás a jobb alsó sarokba.
  • 2 - SIG_LEFT_TOP Igazítás a bal felső sarokba.
  • 3 - SIG_LEFT_BOTTOM Igazítás a bal alsó sarokba.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetImgSize([in] LONG size, [in] VARIANT_BOOL percent, [in] LONG mode);

A látható PDF aláírás létrehozásánál megadhatjuk a megadott kép átméretezésre vonatkozó paramétereket. Ez a beállítás felülbírálja a korábban SetPDFSignImgSize -zal beállított értékeket.

Paraméter:

• LONG size – Képméret.
• VARIANT_BOOL percent – Ha az értéke true, akkor a size paraméter érétke képpontban értelmezett érték, ellenkező esetben a dokumentum vonatkozó méretének százalékos értékét jelenti. Például ha a dokumentum szélessége 600 képpont, size = 10 és a percent = true, akkor az új szélesség 60 képpont lesz.
• LONG mode – Az átméretezés módja. Átméretezéskor minden esetben arányosan csökkentjük, ill. növeljük a megadott kép függőleges és vízszintes méretét. Tehát az átméretezés után a magasság-szélesség aránya változatlan marad. Így a megadott size értéket többféle módon értelmezhetjük. Lehetséges értékei:
  • 0 - XS_PDF_SIGSIZEMODE_MAX Ha a kép magassága nagyobb, mint a szélessége akkor ugyanaz, mint a XS_PDF_SIGSIZEMODE_HEIGHT, különben a XS_PDF_SIGSIZEMODE_WIDTH módot használjuk. Ez az alapértelmezett üzemmód.
  • 1 - XS_PDF_SIGSIZEMODE_WIDTH A size-al megadott érték lesz az új szélessége az átméretezett képnek.
  • 2 - XS_PDF_SIGSIZEMODE_HEIGHT A size-al megadott érték lesz az új magassága az átméretezett képnek.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetImgPadding([in] LONG padding_x, [in] VARIANT_BOOL x_percent, [in] LONG padding_y, [in] VARIANT_BOOL y_percent);

Megadhatjuk a látható PDF aláírás vízszintes távolságát a lap széleitől. Ez a beállítás felülbírálja a korábban SetPDFSignImgPadding -gal beállított értékeket.

Paraméter:

• LONG padding_x - Vízszintes behúzás. Megadhatjuk a látható aláírás vízszintes távolságát a lap szélétől, a SetPDFSignImgSize paraméterezésénél leírt módon, képpontban vagy lapméret százalékban.
• VARIANT_BOOL x_percent – Értéke true ha a padding_x értéke százalékban értendő.
• LONG padding_y – Függőleges behúzás. Megadhatjuk a látható aláírás függőleges távolságát a lap szélétől, a SetPDFSignImgSize paraméterezésénél leírt módon, képpontban vagy lapméret százalékban.
• VARIANT_BOOL y_percent – Értéke true ha a padding_y értéke százalékban értendő.

Visszatérési érték:

LONG SetMode([in] LONG imgMode);

Beállítható a látható PDF aláírás megjelenítésének módja. Ez a beállítás felülbírálja a korábban SetPDFSignImgMode -dal beállított értéket.

Paraméter:

• LONG imgMode - Bemeneti paraméter. A paraméterben következő értékek szerepelhetnek:
  • 0 - SIG_SHOW Legyen látható az aláírás képe a dokumentumban.
  • 1 - SIG_HIDDEN Legyen rejtett az aláírás képe a dokumentumban.

Visszatérési érték:

LONG SetImgTitleMode([in] LONG tileMode);

A látható PDF aláíráson elhelyezett felirat megjelenítés módja. Ez a beállítás felülbírálja a korábban SetPDFSignImgTitleMode -dal beállított értéket.

Paraméter:

LONG tileMode - Bemeneti paraméter. A paraméterben következő értékek szerepelhetnek:

• 0 - SIG_TM_CN Legyen látható az aláírás szövege, tartalma pedig legyen az aláíró tanúsítványában szereplő Subject.CN mező, ha nincs megadva a SetPDFSignImgTitle.
• 1 - SIG_TM_HIDDEN Ne legyen látható szöveg a látható aláírás fölött.

Visszatérési érték:

LONG SetImgTitleAlign([in] LONG align);

A látható PDF aláíráson elhelyezett felirat igazítása valamelyik élhez.

Paraméter:

• LONG align - Bemeneti paraméter. A paraméterben következő értékek szerepelhetnek:
  • 0 - SIG_TA_BOTTOM Szöveg igazítása az alsó élhez.
  • 1 - SIG_TA_TOP Szöveg igazítása a felső élhez.

Visszatérési érték:

LONG SetImgTitle([in] BSTR title);

A látható PDF aláíráson opcionálisan elhelyezhető szöveg. Alapértelmezett értéke az aláíró tanúsítványában szereplő Subject.CN értéke. Ez a beállítás felülbírálja a korábban SetPDFSignImgTitle -lel beállított értéket.

Paraméter:

• BSTR title - Tetszőleges szöveg.

A szövegbe elhelyezhetőek az aláírás időpontjához vagy az aláírói tanúsítványhoz kapcsolódó adatok is:

• %TSD% - Aláírás dátuma %Y-%m-%d formátumban (lokális idő).
• %TSH% - Aláírás időpontja %H:%M:%SZ formátumban (lokális idő).
• %CN% - Aláírói tanúsítványban szereplő Subject.CN (common name) mező értéke.
• %OU% - Aláírói tanúsítványban szereplő Subject.OU (organization unit) mező értéke.
• %O% - Aláírói tanúsítványban szereplő Subject.O (organization) mező értéke.
• %L% - Aláírói tanúsítványban szereplő Subject.L (locality) mező értéke.
• %T% - Aláírói tanúsítványban szereplő Subject.T (title) mező értéke.
• %SERIAL% - Aláírói tanúsítvány sorozatszáma.

Visszatérési érték:

LONG SetImgTitleFontSize([in] LONG size);

A látható PDF aláíráson megjelenített szöveg betűmérete. Alapértelmezett értéke: 22 Ez a beállítás felülbírálja a korábban SetPDFSignImgTitleFontSize -zal beállított értéket.

Paraméter:

• LONG size – Betűméret.

Visszatérési érték:

LONG SetImgTitlePadding([in] LONG x, [in] LONG y);

A látható PDF aláíráson elhelyezett szöveg, név távolsága a látható aláírás képének szélétől. Ez a beállítás felülbírálja a korábban SetPDFSignImgTitlePadding -val beállított értéket.

Paraméter:

• LONG x - A látható aláíráson elhelyezett szöveg, név vízszintes irányú távolsága a látható aláírás képének szélétől. Ha nincs megadva a látható aláírás képe és nincs is tiltva a megjelenítése, akkor ennek a paraméternek nincs hatása.
• LONG y - A látható aláíráson elhelyezett szöveg, név függőleges irányú távolsága a látható aláírás képének szélétől. Ha nincs megadva a látható aláírás képe és nincs is tiltva a megjelenítése, akkor ennek a paraméternek nincs hatása.

Visszatérési érték:

LONG SetPAdES([in] LONG pades);

ETSI (TS 102 778) szabványnak megfelelő PAdES aláírás készítését teszi lehetővé.

Ez a beállítás felülbírálja a korábban SetPDFPAdES – sel beállított értéket.

Paraméter:

• LONG pades – Bemeneti paraméter, a paraméterben a következő értékek szerepelhetnek:
  • 0 - SIG_PADES_DIS PAdES aláírás kikapcsolva.
  • 1 - SIG_PADES_ENA PAdES aláírás engedélyezve.

Visszatérési érték:

LONG SetSignaturePolicy([in] BSTR sigPolicyURI, [in, defaultvalue("")] BSTR sigPolicyOID);

A PDF aláíráson értelmezett aláírási szabályzat URI-ja és OID-ja (ha szükséges), XAdES-EPES létrehozásához. Nincs alapértelmezett értéke.

Paraméter:

• BSTR sigPolicyURI - Aláírási szabályzat URI-ja. Nincs alapértelmezett értéke.
• BSTR sigPolicyOID - Aláírási szabályzat OID-ja, akkor szükséges megadni, ha a szabályzat nem ASN1 formátumú.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetCommitmentType([in] BSTR commitmentTypeOID);

A PDF aláíráson értelmezett kötelezettség-vállalás, OID-ként megadva. Nincs alapértelmezett értéke.

Paraméter:

• String commitmentTypeOID - Az aláíró kötelezettség-vállalása. CAdES szabvány szerinti lehetséges értékek:
• 1.2.840.113549.1.9.16.6.1 – eredet igazolása
• 1.2.840.113549.1.9.16.6.2 – átvételi elismervény
• 1.2.840.113549.1.9.16.6.3 – kézbesítés igazolása
• 1.2.840.113549.1.9.16.6.4 – elküldés igazolása
• 1.2.840.113549.1.9.16.6.5 – jóváhagyás
• 1.2.840.113549.1.9.16.6.6 – létrehozás igazolása

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG SetContentHint([in] BSTR contentHintDescription, [in] BSTR contentHintType);

A PDF aláíráshoz megadható paraméter, amely multi-layer message esetén a belső tartalom típusát jelöli. Nincs alapértelmezett értéke.

Paraméter:

• String contentHintDescription - Multi-layer message esetén a belső tartalom típusát írja le. Értéke jellemzően mime típus. Nincs alapértelmezett értéke. Részletes leírás az RFC 2634 [5] dokumentumban és az ETSI TS 101 733 leírásban található.
• String contentHintType - Multi-layer message esetén a belső tartalom típusát megadó OID. Nincs alapértelmezett értéke. Részletes leírás az RFC 2634 [5] dokumentumban és az ETSI TS 101 733 leírásban található.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG AddTimeStamp([in] VARIANT_BOOL unknownSubfilterFlags);

Fő funkciója egy újabb dokumentum időbélyeg PDF-be illesztése. Amennyiben a PDF már tartalmaz aláírásokat, úgy az összeset leellenőrzi az időbélyegzés előtt. Figyelem! A metódus akkor is elhelyez egy időbélyeget a PDF-en, ha nincs aláírva! Amennyiben a dokumentum tartalmaz adbe.x509.rsa_sha1 SubFilter értékű aláírásokat, akkor a PAdES-LTV szintű aláírás nem támogatott.

Paraméter:

• VARIANT_BOOL unknownSubfilterFlags – Bemeneti paraméter. Amennyiben értéke TRUE, az XSign4COM átlépi az ismeretlen subFilter értékkel rendelkező aláírásokat, tehát nem is rakja bele a kimeneti tömbbe azokat. FALSE érték esetén hibát jelez ismeretlen subFilter esetén.

Visszatérési érték:

LONG DeleteLastVersion();

Visszaállítja a legutolsó aláírás vagy időbélyegzés előtti PDF dokumentumot. Teljes archív aláírás esetén a teljes aláírás törléséhez két hívás szükséges (első hívás az archív időbélyegre, második hívás az aláírásra).

Visszatérési érték:

LONG AddAttachment([in] BSTR attachment, [in] BSTR description, [in] VARIANT* attachmentData);

PDF fájlba csatolt dokumentum beillesztése.

Paraméter:

• BSTR attachment – Bemeneti paraméter. Amennyiben az attachmentData NULL, ez a paraméter a csatolmány elérési útja, amennyiben van attachmentData ez a csatolmány neve.
• BSTR description - Bemeneti paraméter. A csatolmány leírása.
• VARIANT* attachmentData - Bemeneti paraméter. A csatolmány bájtsorozata. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal)

Visszatérési érték:

LONG AddMetadata([in] IDispatch* pdfMetadataMap);

Saját metaadat hozzáadása a PDF dokumentumhoz.

Paraméter:

• IDispatch* pdfMetadataMap – Bemeneti paraméter. IXSignPDFMetadataMap interfészre mutató pointer, amely a PDF-hez hozzáadni kívánt metaadat név-érték párokat tartalmazza.

Visszatérési érték:

IDispatch * GetSignedPDF();

Visszaadja az aláírás által aláírt PDF dokumentum verziót. A visszaadott PDF dokumentum nem feltétlenül azonos azzal a dokumentummal, amelyben a PDF aláírás található, mert a dokumentumon az aláírás után egyéb változtatások (pl. további aláírások elhelyezése) történhettek. Ez a metódus az utólagos változtatások nélküli verziót adja vissza, amit az aláírás véd (amire „vonatkozik”).

Visszatérési érték:

Az aláírás által védett PDF dokumentum verziót reprezentáló új IXSignPDFDocument interfészre mutató pointer, hiba esetén NULL.

BSTR GetUnsignedHash();

Visszaadja az aláíratlan lenyomatot. Az XSign hibakódot az IXSignPDFDocument::GetLastError() meghívásával kaphatjuk meg.

Visszatérési érték:

Az BASE64 kódolt aláíratlan lenyomatot tartalmazó string.

BSTR GetUnsignedHash();

Ez a metódus kinyeri az aláíratlan lenyomatot.

Visszatérési érték:

A base64 kódolt aláíratlan lenyomatot tartalmazó string.

LONG SetSignedHash([in] BSTR signedHash);

Beilleszti az aláírt lenyomatot. Szükség esetén kiterjeszti az aláírást a megadott típusúra.

Paraméter:

• BSTR signedHash – Bemeneti paraméter. Az BASE64 kódolt aláírt lenyomatot tartalmazó string.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetSignerDN();

Visszaadja az aláírói tanúsítvány signer.DN mezőjének tartalmát.

Visszatérési érték:

A signer.DN-t tartalmazó string.

BSTR GetName();

Visszaadja a PDF aláírás name mezőjének tartalmát.

Visszatérési érték:

A name mezőt tartalmazó string.

BSTR GetSignTime();

A PDF aláírás létrehozásának időpontja "yyyy-MM-dd'T'HH:mm:ss'Z'" formátumban (GMT:00).

Visszatérési érték:

A PDF aláírás létrehozásának időpontját tartalmazó string.

VARIANT_BOOL GetSignatureCoversWholeDocument();

Megadja, hogy az aláírás az egész dokumentumot védi-e.

Visszatérési érték:

true ha az aláírás az egész dokumentumot védi, különben false.

BSTR GetRevision();

Az aláírás revíziójának azonosítója „N of N” alakban.

Visszatérési érték:

A revízió azonosítóját tartalmazó string.

VARIANT_BOOL HasSignatureTimeStamp();

Visszaadja, hogy a PDF aláírás tartalmazza-e az időpontját igazoló időbélyeget.

Visszatérési érték:

true ha az aláíráson van időbélyeg, különben false.

LONG GetPadesType();

Visszaadja a PDF aláírás PAdES típusát.

Visszatérési érték:

• UNDEF = -1
• PADES_BES = 1
• PADES_EPES = 2
• PADES_T = 3
• PADES_C = 4
• PADES_X = 5
• PADES_X_L = 6
• PADES_A = 7

VARIANT_BOOL IsLTVEnabled();

Megadja,hogy az adott PDF aláírás LTV (Long Term Validation) támogató-e, azaz tartalmaz-e DSS (Document Security Store) elemet és Document Timestamp elemet.

Visszatérési érték:

true ha LTV támogató, különben false.

BSTR GetCommitmentType();

Visszaadja a kötelezettségvállalás típusának OID-ját. A lehetséges OID-ok leírása az IXSignPDFDocument interfész SetCommitmentType függvényének leírásánál található.

Visszatérési érték:

Kötelezettségvállalás típusának OID-ja.

BSTR GetSignaturePolicy();

Az aláíráskor használt aláírási szabályzat URL-jét adja vissza a metódus.

Visszatérési érték:

Az aláírási szabályzat URL-jét tartalmazó String objektum.

void AddHostCertAuthData(BSTR sHostName, BSTR sPFXPath, BSTR sPFXPassword)

A lista végéhez csatol egy új hosztnév, PFX elérési útvonal, PFX jelszó hármast.

ULONG GetHostCount();

Visszaadja a hosztnév, PFX elérési útvonal, PFX jelszó hármasok számát a listában.

Visszatérési érték:

A hosztnév, PFX elérési útvonal, PFX jelszó hármasok száma.

BSTR GetHostName(ULONG i);

Visszaadja a hosztnevet az i-edik hosztnév, PFX elérési útvonal, PFX jelszó hármasból.

Paraméter:

• ULONG i – az elem pozíciója a listában

Visszatérési érték:

A hosztnév az i-edik hosztnév, PFX elérési útvonal, PFX jelszó hármasból.

BSTR GetPFXPath(ULONG i);

Visszaadja a PFX elérési útvonalat az i-edik hosztnév, PFX elérési útvonal, PFX jelszó hármasból.

Paraméter:

• ULONG i – az elem pozíciója a listában

Visszatérési érték:

A PFX elérési útvonal az i-edik hosztnév, PFX elérési útvonal, PFX jelszó hármasból.

BSTR GetPFXPassword(ULONG i);

Visszaadja a PFX jelszót az i-edik hosztnév, PFX elérési útvonal, PFX jelszó hármasból.

Paraméter:

• ULONG i – az elem pozíciója a listában

Visszatérési érték:

A PFX jelszó az i-edik hosztnév, PFX elérési útvonal, PFX jelszó hármasból.

void AddBasicAuthData(BSTR login, BSTR password, BSTR host)

A lista végéhez csatol egy új felhasználónév, jelszó, hosztnév hármast.

ULONG GetListCount();

Visszaadja a felhasználónév, jelszó, hosztnév hármasok számát a listában.

Visszatérési érték:

A felhasználónév, jelszó, hosztnév hármasok száma.

BSTR GetHostName(ULONG i);

Visszaadja a hosztnevet az i-edik felhasználónév, jelszó, hosztnév hármasból.

Paraméter:

• ULONG i – az elem pozíciója a listában

Visszatérési érték:

A hosztnév az i-edik felhasználónév, jelszó, hosztnév hármasból.

BSTR GetPassword(ULONG i);

Visszaadja a jelszót az i-edik felhasználónév, jelszó, hosztnév hármasból.

Paraméter:

• ULONG i – az elem pozíciója a listában

Visszatérési érték:

A jelszó az i-edik felhasználónév, jelszó, hosztnév hármasból.

BSTR GetUsrName(ULONG i);

Visszaadja a felhasználónevet az i-edik felhasználónév, jelszó, hosztnév hármasból.

Paraméter:

• ULONG i – az elem pozíciója a listában

Visszatérési érték:

A felhasználónév az i-edik felhasználónév, jelszó, hosztnév hármasból.

BSTR elementNSHref

az elem névtere (csak olvasható)

BSTR elementName

az elem neve (csak olvasható)

BSTR attributeNSHref

az attribútum névtere (csak olvasható)

BSTR attributeNSHref

az attribútum neve (csak olvasható)

void Set(BSTR sElementNSHref, BSTR sElementName, BSTR sAttributeNSHref, BSTR sAttributeName)

A paramétereknek megfelelően beállítja az attribútumokat.

LONG value

a validálás eredményének hibakódja; lásd: XSign visszatérési értékek

VARIANT output

a validálás eredményének XML kimenete (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal)

void StatusMessageEvent(BSTR sMsg);

Ezek az események a státuszüzeneteket tartalmazzák. Figyelem! Az üzenetek feldolgozását végző függvény nem hívhat meg XSign4COM metódust, mert az azokban elhelyezett zárak miatt blokkolódás alakulhat ki.

Paraméter:

• BSTR sMsg – A státuszüzenet.

LONG GetLastError();

Az utolsó művelet sikerességéről szóló információt (lásd XSign visszatérési értékek című alfejezet) kérhetjük le.

Visszatérési érték:

Az XSign legutóbbi visszatérési értéke (lásd XSign visszatérési értékek című alfejezet).

BSTR GetURI()

Visszaadja az aláírt dokumentum URI-ját.

Visszatérési érték:

Az aláírt adat lehet egy fájl. Ekkor egy elérési út vagy egy URL lesz a visszatérési érték. Egyébként egy azonosító.

BSTR GetMIMEType()

Visszaadja az aláírt adat MIME típusát.

Visszatérési érték:

Az aláírt adat MIME típusa. Például: text/plain

BSTR GetType()

A referencia típusa. (A Type XML attribútum értéke.)

Visszatérési érték:

A referencia típusa.

BSTR GetDigestMethod()

Az aláírásban szerepel a hivatkozott adatból képzett hash érték. A metódus visszaadja, melyik hash algoritmust használták.

Visszatérési érték:

A hash algoritmus URI-ja. Például: http://www.w3.org/2001/04/xmlenc#sha256

VARIANT GetDigestValue()

A hivatkozott adatból képzett hash érték a referenciában. A metódus visszaadja ezt az értéket egy byte tömbben.

Visszatérési érték:

Hash érték byte tömbben. (SAFEARRAY tömbben VT_ARRAY | VT_UI1 típussal.)

BSTR GetSignaturePolicy();

Az aláírási szabályzat nevét adja vissza.

Visszatérési érték:

Az aláírási szabályzat neve.

BSTR GetSigPlacePostalCode()

Az aláírás helyét adja vissza (irányítószám).

Visszatérési érték:

Irányítószám.

BSTR GetSigPlaceSettlement()

Az aláírás helyét adja vissza (település).

Visszatérési érték:

Település.

BSTR GetSigPlaceProvince()

Az aláírás helyét adja vissza (megye).

Visszatérési érték:

Megye.

BSTR GetSigPlaceCountry()

Az aláírás helyét adja vissza (ország).

Visszatérési érték:

Ország.

BSTR GetSignerRole()

Az aláíró szerepét adja vissza.

Visszatérési érték:

Szerep.

BSTR GetCommitmentType()

Az aláíró kötelezettségvállalásának az azonosítóját adja vissza.

Visszatérési érték:

A kötelezettségvállalás azonosítója (URI).

LONG GetCommentType()

Az aláíráshoz csatolt megjegyzés típusát adja vissza.

Visszatérési érték:

A megjegyzés típusa. Lehetséges értékek:

• 0 - záradék
• 1 - széljegyzet
• 2 - megjegyzés
• 3 - vélemény

LONG GetRegulation()

Visszaadja annak a szabályozásnak az azonosítóját, amelynek a tanúsítvány megfelel.

Visszatérési érték:

A szabályozás azonosítója. Lehetséges értékek:

• 0 - egyik sem
• 1 - 1999/93/EC
• 2 - eIDAS / (EU) No 910/2014)

LONG GetQualification();

A tanúsítvány minősítésének azonosítóját adja vissza.

Visszatérési érték:

A minősítés azonosítója. Lehetséges értékek:

• 0 - nem minősített
• 1 - minősített, de a magánkulcs nem MALÉ-n van
• 2 - minősített, és a magánkulcs MALÉ-n van

LONG GetStatement()

A tanúsítványban szereplő qcStatements kiterjesztésről ad információt.

Visszatérési érték:

A qcStatements állapota, lehetséges értékek:

• -1 - a qcStatements kritikusnak van jelölve, és hibás
• 0 - nincs qcStatements
• 1 - a qcStatements jelen van, és nem hibás
• 2 - a qcStatements jelen van, és kritikusnak van jelölve

DOUBLE GetLimitValue()

A tranzakciós limit értékét adja vissza.

BSTR GetLimitValueCurrency()

A tranzakciós limit pénznemét adja vissza.

LONG GetRetentionPeriod()

A megőrzési időt adja vissza.

LONG GetTypes()

A tanúsítvány típusát jelző biteket adja vissza VAGY kapcsolatban.

Az alábbi bitekből több is szerepelhet:

• 0 - (nincs semmi sem beállítva)
• 1 - aláírás
• 2 - bélyegző
• 4 - webszerver

VARIANT GetPDSLanguages()

A PKI Disclosure Statement-ek (PDS-ek) elérhető nyelveinek listáját (a kétbetűs kódokat) adja vissza egy SAFEARRAY-ben.

VARIANT GetPDSListForLanguage(BSTR language)

A megadott nyelvhez tartozó PKI Disclosure Statement-ek (PDS-ek) listáját adja vissza egy SAFEARRAY-ben.

Paraméter:

• BSTR language – a nyelv azonosítója (kétbetűs kód)

IDispatch* GetPSD2QCType()

Egy IXSignPSD2QCType objektumot ad visszza, ami PSP szerepkörökkel és NCA-val kapcsolatos információkat tartalmaz.

BSTR GetNCAName()

Az NCA nevét adja vissza.

BSTR GetNCAId()

Az NCA azonosítóját adja vissza.

IDispatch* GetRoleOfPSPAt(LONG index)

A megadott indexhez tartozó PSP szerepet adja vissza.

Paraméter:

• LONG index – a szerepkör indexe.

BSTR GetRolesOfPSPSize()

A PSP szerepkörök számát adja vissza.

BSTR GetPSPOid()

A PSP szerepkör OID-ját adja vissza.

BSTR GetPSPName()

A PSP szerepkör rövidített nevét adja vissza.

LONG StartSession(BSTR pStartURL, VARIANT* pDocumentList, BSTR pSPName, BSTR pMessage, BSTR pScheme, BSTR pFilters)

Új ESign munkamenet indítása. Jelenleg a parancs segítségével egy dokumentum kétmenetes aláírásához lehet munkamenetet indítani. Használat előtt szükséges lehet az ESign központi szerverrel való biztonságos kommunikációhoz szükséges egyéb paraméterek (pl. authentikációs adatok) beállítása is.

Paraméterek:

• BSTR pStartURL – Bemeneti paraméter. A központi szerver URL-je, amelyhez a munkamenet indítási kérelmet intézzük.
• BSTR pDocumentList – Bemeneti paraméter. Az aláírandó dokumentumok listája útja.
• BSTR pSPName – Bemeneti paraméter. Kiszolgáló neve, amit a másik fél aláíró alkalmazása megjelenít.
• BSTR pMessage – Bemeneti paraméter. Aláírói üzenet, amit a másik fél aláíró alkalmazása megjelenít.
• BSTR pScheme – Bemeneti paraméter. Opcionálisan megadható URI séma, értéke lehet NULL, ekkor az alapértelmezett "esign" lesz beállítva.
• BSTR pFilters – Bemeneti paraméter. String, ami JSON formátumban tartalmazza a protokoll során használt tanúsítványhoz támasztott szűrőfeltételeket (további információkért lásd az ESign protokoll dokumentációját). Opcionális, értéke lehet NULL.
• VARIANT_BOOL documentStateProvided – Bemeneti paraméter. Igaz érték esetén jelzi az e-Szignó a közvetítő szervernek, hogy támogatjuk a dokumentumok állapotának beállítását (lásd: SetDocumentState függvény). Alapértelmezett értéke: 0 (hamis).

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetSessionJSON(LONG qrType, BSTR pScheme)

Visszaadja a létrehozott session paramétereit JSON formátumban (session ID, session URL, dokumentum paraméterei). Adatfeldolgozás céljából használható függvény, a protokoll futásához közvetlen nem szükséges. Csak StartSession hívás után használható.

Paraméterek:

• LONG pQRType – Bemeneti paraméter. A később lekérhető QR kód képformátumát tartalmazó pointer. Lehetséges értékei: 0 (.bmp), 1 (.png). Értéke lehet NULL, ha nem kívánunk a QR kóddal foglalkozni (ekkor alapértelmezetten bmp formátumú QR kód kérhető le később).
• BSTR pScheme – Bemeneti paraméter. Opcionálisan megadható URI séma, értéke lehet NULL, ekkor az alapértelmezett "esign" lesz beállítva.

Visszatérési érték:

JSON formátumú szöveg.

VARIANT GetQRCode(BSTR customURIScheme, LONG formatQR)

Visszaad egy mobilos applikáció számára felhasználható QR kódot - ennek segítségével az aláírást intéző kliens is futtathatja a protokollt. Csak StartSession hívás után használható.

Paraméterek:

• BSTR customURIScheme – Opcionálisan megadható URI séma, értéke lehet null, ekkor az alapértelmezett "esign" lesz beállítva.
• LONG formatQR – A később lekérhető QR kód képformátuma. Lehetséges értékei: 0 (.bmp), 1 (.png). Nincs alapértelmezett értéke.

Visszatérési érték:

QR kód, a StartSession hívásnál megadott formátumban.

LONG SetPollSettings(LONG pollDelay, LONG pollTimeout)

Beállítja a polling során használatos hálózati paramétereket.

Paraméterek:

• LONG pollDelay – Bemeneti paraméter. Két lekérdezés közötti időköz másodpercben megadva.
• LONG pollTimeout – Bemenetei paraméter. Időtúllépés másodpercben megadva - figyelem, ez nem a szerver válaszidejére vonatkozik, hanem a polling időtartamára.

Visszatérési érték:

Sikeres művelet esetén a visszatérési érték 0 (XSR_OK). Ha valamely paraméternél 0 másodpercet adunk meg, XSR_ARGUMENTS_BAD-el tér vissza.

LONG CancelSession()

ESign munkamenet törlése. Erre akkor lehet szükség például, ha a kétmenetes aláírás első fázisához lejárt tanúsítványt kaptunk az aláíró klienstől. Csak StartSession hívás után használható.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

VARIANT GetCertificate(BSTR certURL)

Aláírói tanúsítvány lekérése az ESign központi szervertől. A kétmenetes aláírás első feléhez szükséges. Csak StartSession hívás után használható.

Paraméterek:

• BSTR certURL – Bemeneti paraméter. Az ESign központi szerver tanúsítvány lekéréshez tartozó URL-je.

Visszatérési érték:

A tanúsítványt tartalmazó byte tömb.

VARIANT GetSignedHashes(BSTR unsignedHashURL, BSTR signedHashURL, VARIANT* unsignedHash, VARIANT_BOOL usePKCS7)

Aláírt hash lekérése az ESign központi szervertől. A kétmenetes aláírás második feléhez szükséges. Ugyanezen parancson belül megtörténik az aláíratlan hash felküldése is (ezt írja majd alá a kliens). Csak StartSession hívás után használható.

Paraméterek:

• BSTR unsignedHashURL – Bemeneti paraméter. Az ESign központi szerver aláíratlan hash felküldéséhez tartozó URL-je
• BSTR signedHashURL – Bemeneti paraméter. Az ESign központi szerver aláírt hash lekéréshez tartozó URL-je
• VARIANT* unsignedHash – Bemeneti paraméter. Az aláíratlan lenyomatokat base64 kódolva tartalmazó tömb, amelyet a másik fél alá fog írni
• VARIANT_BOOL usePKCS7 – Bemeneti paraméter. "Igaz" érték esetén az ESign szervernek PKCS7 aláírással együtt küldi fel az aláíratlan hash-t az e-szignó (lásd ESign protokoll leírás). Megjegyzés: a Microsec ESign központi szerver a nem teszt felhasználóknál a setUnsignedHashes kérést csak aláírva fogadja el, ilyenkor tehát az opció értéke "igaz" kell, hogy legyen és be kell állítani egy megfelelő aláírói tanúsítványt is.

Visszatérési érték:

A base64 kódolt aláírt lenyomatok tömbje.

LONG GetLastError()

Utolsó hiba lekérése.

Visszatérési érték:

XSign hibakód.

LONG SetDocumentState(BSTR setDocumentStateURL, VARIANT* docStateList, VARIANT* docStateCommentList)

A dokumentumok állapotának közvetítő szerver felé történő megadását szolgáló függvény. Az állapotok megadásával lehet jelezni a közvetítő szervernek, hogy sikerült-e az aláírás, vagy esetleg valami hiba történt. Csak StartSession hívás után használható.

Paraméterek:

• BSTR setDocumentStateURL – Bemeneti paraméter. Az ESign központi szerver dokumentum állapotok megadásához tartozó URL-je
• VARIANT* docStateList – Bemeneti paraméter. A StartSession hívásnál megadott dokumentumok állapotait tartalmazó lista. Minden dokumentumhoz kötelező állapotot megadni, pontosan a dokumentumok sorrendjében. Lehetséges értékek: signed (a dokumentumot sikerült aláírni), can_not_be_signed (hiba történt az aláírási folyamat közben), unsigned (aláírás folyamatban, ez a dokumentumok eredeti állapota a session kezdetekor, ha nincs állapotváltozás, ezt kell megadni).
• VARIANT* docStateCommentList – Bemeneti paraméter. A dokumentumok állapotaihoz tartozó szöveges megjegyzés. Opcionális paraméter, megadásakor azonban minden dokumentumhoz kötelező megjegyzést megadni (akár egy üres szöveg formájában), pontosan a dokumentumok sorrendjében.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG Save(BSTR containerPath)

ASiC konténer mentése egy megadott elérési útvonalra.

Paraméterek:

• BSTR containerPath – Bemeneti paraméter. A konténer elérési útja. Kötelező paraméter, alapértelmezett értéke nincs.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG Free()

Felszabadítja az ASiC konténerrel kapcsolatos memóriaterületeket az XSign DLL-en belül. Figyelem! A függvény hatására mind az XSignASiCContainer, mind az abban található dokumentumokat ill. aláírásokat jelentő XSignASiCDocument és XSignASiCSignature objektumok használhatatlanná válnak. Metódusaik meghívása nem definiált működéshez vezet!

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

IDispatch * InsertDocument(BSTR documentPath, BSTR documentURI)

Fájlrendszerből beilleszt egy dokumentumot a konténerbe. Windows operációs rendszeren az alkalmazás automatikusan felismeri a fájl MIME típusát, ha az be van regisztrálva a Windowsba.

Paraméterek:

• BSTR documentPath – Bemeneti paraméter. A beillesztendő dokumentum elérési útja. Kötelező paraméter, alapértelmezett értéke nincs.
• BSTR documentURI – Bemeneti paraméter. A dokumentum címe. Opcionális paraméter, ha nem adjuk meg, a dokumentum eredeti fájlneve lesz a cím.

Visszatérési érték:

Egy új IXSignASiCDocument típusú pointer. Ennek a pointernek a segítségével érhetjük el a dokumentumhoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

VARIANT GetDocuments()

Visszaadja a konténerben található dokumentumokat.

Visszatérési érték:

A konténer dokumentumait tartalmazó tömb egy VARIANT értékben. A tömb minden eleme egy IXSignASiCDocument típusú pointer. Sikertelen művelet esetén NULL a visszatérési érték.

VARIANT GetSignatures()

Visszaadja a konténerben található aláírásokat.

Visszatérési érték:

A konténer aláírásait tartalmazó tömb egy VARIANT értékben. A tömb minden eleme egy IXSignASiCSignature típusú pointer, egy-egy aláíráshoz több dokumentum is tartozhat. Sikertelen művelet esetén NULL a visszatérési érték.

IDispatch * Sign(VARIANT* pDocList)

A megadott dokumentum listában található dokumentumokat írja alá. A GetDocuments függvénnyel lekért tömböt közvetlenül átadva a konténer minden dokumentumát aláírhatjuk egyszerre. Ha nem a konténerhez tartozó dokumentumokat akarunk aláírni, hibával tér vissza.

Paraméterek:

• VARIANT* pDocList – Bemeneti paraméter. Az aláírandó dokumentumok tömbje, minden elem egy IXSignASiCDocument típusú pointer.

Visszatérési érték:

Egy új IXSignASiCSignature típusú pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * SignWithProperties(VARIANT* pDocList, BSTR signaturePolicyURL, BSTR signaturePlacePostalCode, BSTR signaturePlaceSettlement, BSTR signaturePlaceProvince, BSTR signaturePlaceCountry, BSTR signerRole, BSTR commitmentType );

A megadott dokumentum listában található dokumentumokat írja alá. Aláíráskor megadható számos az aláírás körülményével kapcsolatos adat, így például: aláírási szabályzat, aláírás helye, aláíró szerepe, stb.

Paraméterek:

• VARIANT* pDocList – Bemeneti paraméter. Az aláírandó dokumentumok tömbje, minden elem egy IXSignASiCDocument típusú pointer.
• BSTR signaturePolicyURL – Bemeneti paraméter. Az aláírási szabályzat URI-ja. Nincs alapértelmezett értéke.
• BSTR signaturePlacePostalCode – Bemeneti paraméter. Az aláírás helye: irányítószám. Nincs alapértelmezett értéke.
• BSTR signaturePlaceSettlement – Bemeneti paraméter. Az aláírás helye: város. Nincs alapértelmezett értéke.
• BSTR signaturePlaceProvince – Bemeneti paraméter. Az aláírás helye: megye. Nincs alapértelmezett értéke.
• BSTR signaturePlaceCountry – Bemeneti paraméter. Az aláírás helye: ország. Nincs alapértelmezett értéke.
• BSTR signerRole – Bemeneti paraméter. Az aláaró szerepe. Nincs alapértelmezett értéke.
• BSTR commitmentType – Bemeneti paraméter. Az aláíró kötelezettség-vállalása. Nincs alapértelmezett értéke. A XAdES szabvány szerinti lehetséges értékei:
  • http://uri.etsi.org/01903/v1.2.2#ProofOfOrigin – eredet igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfReceipt – átvételi elismervény
  • http://uri.etsi.org/01903/v1.2.2#ProofOfDelivery – kézbesítés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfSender – elküldés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfApproval – jóváhagyás
  • http://uri.etsi.org/01903/v1.2.2#ProofOfCreation – létrehozás igazolása

Visszatérési érték:

Egy új IXSignASiCSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

VARIANT GetUnsignedSignatures()

Visszaadja a konténerben található félkész aláírásokat. Kétmenetes aláírás esetén használható.

Visszatérési érték:

A konténer félkész aláírásait tartalmazó tömb egy VARIANT értékben. A tömb minden eleme egy IXSignASiCSignature típusú pointer. Sikertelen művelet esetén NULL a visszatérési érték.

LONG GetLastError()

Utolsó hiba lekérése.

Visszatérési érték:

XSign hibakód.

ULONG GetMainType()

Visszaadja a konténer belső típusát.

A visszatérési értékek a következők lehetnek:

• 0 - ismeretlen
• 1 - ASiC-S
• 2 - ASiC-E

ULONG GetSubType()

Visszaadja a konténer belső altípusát (a benne található aláírások függvényében).

A visszatérési értékek a következők lehetnek:

• 0 - ismeretlen (ha még nincs aláírás benne)
• 1 - XAdES
• 2 - CAdES

ULONG GetDocumentSizeLimit()

Visszaadja a nagy dokumentumok méretkorlátját (a méretkorlát feletti dokumentumok nem a memóriában vannak tárolva, hanem a fájlrendszeren keresztül használja őket az e-Szignó).

Visszatérési érték:

Méretkorlát (bájtban).

BSTR GetMIMEType()

Visszaadja a konténer MIME típusát.

Visszatérési érték:

A MIME típus. Például: application/zip

BSTR GetHeaderComment()

Visszaadja a konténer ZIP fejléc kommentjét (bővebb információért lásd a ZIP fájl formátum specifikációját).

Visszatérési érték:

ZIP fejléc komment.

ULONG GetHandle()

Visszaadja az ASiC dokumentum leíróját.

Visszatérési érték:

A dokumentum leírója.

ULONG GetContainerHandle()

Visszaadja az ASiC dokumentum konténerének leíróját.

Visszatérési érték:

A dokumentumot tartalmazó konténer leírója.

LONG Save(BSTR documentPath)

A megadott helyre lementi az ASiC dokumentumot.

Paraméterek:

• BSTR documentPath – Bemeneti paraméter. Az exportálandó dokumentum fájlrendszerbeli elérési útja. Kötelező paraméter, alapértelmezett értéke nincs.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG Delete()

Törli az ASiC dokumentumot a konténerből. A művelet után a dokumentumon egyik olyan művelet sem értelmezhető, amelyhez konténer szükséges (pl. Sign).

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

VARIANT GetSignatures()

Visszaadja a dokumentumhoz tartozó aláírásokat.

Visszatérési érték:

A dokumentum aláírásait tartalmazó tömb egy VARIANT értékben. A tömb minden eleme egy IXSignASiCSignature típusú pointer. Sikertelen művelet esetén NULL a visszatérési érték.

BSTR GetPathInContainer()

Visszaadja a dokumentum elérési útját a konténerben.

Visszatérési érték:

Az elérési út.

BSTR GetMIMEType()

Visszaadja a dokumentum MIME típusát.

Visszatérési érték:

A MIME típus. Például: application/zip

BSTR GetTitle()

Visszaadja a dokumentum címét a konténerben.

Visszatérési érték:

A dokumentum címe.

IDispatch* Sign()

Aláírja a dokumentumot és visszaadja az elkészült aláírást reprezentáló objektumot.

Visszatérési érték:

Egy új IXSignASiCSignature típusú pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

IDispatch * SignWithProperties(BSTR signaturePolicyURL, BSTR signaturePlacePostalCode, BSTR signaturePlaceSettlement, BSTR signaturePlaceProvince, BSTR signaturePlaceCountry, BSTR signerRole, BSTR commitmentType );

Aláírja a dokumentumot. Aláíráskor megadható számos az aláírás körülményével kapcsolatos adat, így például: aláírási szabályzat, aláírás helye, aláíró szerepe, stb.

Paraméterek:

• BSTR signaturePolicyURL – Bemeneti paraméter. Az aláírási szabályzat URI-ja. Nincs alapértelmezett értéke.
• BSTR signaturePlacePostalCode – Bemeneti paraméter. Az aláírás helye: irányítószám. Nincs alapértelmezett értéke.
• BSTR signaturePlaceSettlement – Bemeneti paraméter. Az aláírás helye: város. Nincs alapértelmezett értéke.
• BSTR signaturePlaceProvince – Bemeneti paraméter. Az aláírás helye: megye. Nincs alapértelmezett értéke.
• BSTR signaturePlaceCountry – Bemeneti paraméter. Az aláírás helye: ország. Nincs alapértelmezett értéke.
• BSTR signerRole – Bemeneti paraméter. Az aláaró szerepe. Nincs alapértelmezett értéke.
• BSTR commitmentType – Bemeneti paraméter. Az aláíró kötelezettség-vállalása. Nincs alapértelmezett értéke. A XAdES szabvány szerinti lehetséges értékei:
  • http://uri.etsi.org/01903/v1.2.2#ProofOfOrigin – eredet igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfReceipt – átvételi elismervény
  • http://uri.etsi.org/01903/v1.2.2#ProofOfDelivery – kézbesítés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfSender – elküldés igazolása
  • http://uri.etsi.org/01903/v1.2.2#ProofOfApproval – jóváhagyás
  • http://uri.etsi.org/01903/v1.2.2#ProofOfCreation – létrehozás igazolása

Visszatérési érték:

Egy új IXSignASiCSignature interfészre mutató pointer. Ennek a pointernek a segítségével érhetjük el az aláíráshoz tartozó funkcionalitást. Sikertelen művelet esetén NULL a pointer értéke.

LONG GetLastError()

Utolsó hiba lekérése.

Visszatérési érték:

XSign hibakód.

LONG GetLastError()

Utolsó hiba lekérése.

Visszatérési érték:

XSign hibakód.

LONG Delete();

Törli az aktuális aláírást. A törlés után az aláírás objektum érvénytelen lesz és minden rajta végrehajtott művelet hibára fut.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

LONG Validate();

Az aláírás ellenőrzését végzi a metódus. Az ellenőrzés menete függ a IXSignSessionben beállított paraméterektől, így a visszavonás ellenőrzés módját és az esetleges hozzáférési információkat be kell állítani az IXSignSession interfészen keresztül. A funkció ellenőrzi az aláírás sértetlenségét, az aláírói tanúsítvány visszavonási állapotát és az aláíráson elhelyezett időbélyegeket is, tehát elvégzi a komplett aláírás ellenőrzést. Az ellenőrzés során lehetőség van arra, hogy az aláírás típusát megváltoztassuk, kibővítsük visszavonási információkkal és időbélyegekkel.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Érvényes aláírás esetén a visszatérési érték 0 (XSR_OK). Az XSR_INCOMPLETE_VALIDATION hibakód azt jelenti, hogy az ellenőrzés során a valamely tanúsítvány állapotát nem sikerült ellenőrizni. Ez nem jelenti azt, hogy az aláírás nem volt érvényes; ennek leggyakrabban az az oka, hogy egy tanúsítványhoz tartozó visszavonási információból nem áll rendelkezésre a legfrissebb verzió.

VARIANT GetSignedDocuments();

Visszaadja az aláírás által aláírt dokumentumok listáját.

Visszatérési érték:

Az aláírt dokumentumok tömbje egy VARIANT típusban. A tömb minden eleme egy IXSignASiCDocument típusú objektum. Hiba esetén a visszatérési érték NULL.

BSTR GetPathInContainer()

Visszaadja az aláírást reprezentáló xml elérési útját a konténerben.

Visszatérési érték:

Az elérési út.

BSTR GetTitle();

Az adott aláírás címét, azaz az aláíró nevét adja vissza. Automata esetében is az automata aláírói tanúsítványban szereplő nevet adja meg a metódus.

Visszatérési érték:

Az aláíró nevét tartalmazó string.

LONG GetAdesType();

Az aláírás CAdES/XAdES típusát adja vissza a metódus.

Visszatérési érték:

A CAdES/XAdES típus. Lehetséges értékeit XAdES esetén lásd az IXSignSignature::GetXAdESType függvény leírásánál. CAdES esetén az értékekhez rendelt számok a XAdES-el azonosak.

VARIANT_BOOL GetQualified();

Megadja, hogy az aláírói tanúsítvány minősített-e.

Visszatérési érték:

Boolean változó, melynek igaz értéke azt jelenti, hogy az aláíró tanúsítvány minősített. Hamis érték esetén nem minősített tanúsítvánnyal készült az aláírás.

BSTR GetCreationDate();

Az aláírás készítésének az időpontját adja meg.

Visszatérési érték:

Az aláírás készítésének időpontját tartalmazó string.

BSTR GetSignerAlternativeName();

Az aláíró alternatív nevét adja vissza a függvény.

Visszatérési érték:

Az aláíró alternatív nevét tartalmazó string.

BSTR GetCertificateInBase64();

Az aláírói tanúsítványt adja vissza base64 kódolt formában.

Visszatérési érték:

Az aláírói tanúsítványt base64 kódolt formában tartalmazó string.

BSTR GetSignaturePolicy();

Az aláíráskor használt aláírási szabályzat URL-jét adja vissza a metódus.

Visszatérési érték:

Az aláírási szabályzat URL-jét tartalmazó string.

BSTR GetType();

Az aláírás típusát adja vissza szöveges formában.

Visszatérési érték:

Az aláírás típusát tartalmazó string.

IDispatch * GetFirstAttachedTSItem();

Az aláíráshoz tartozó első időbélyeg adatainak az interfészét tudjuk lekérni. A GetNextAttachedTSItem() metódussal együtt használva végigiterálhatunk az összes időbélyegen.

Visszatérési érték:

Egy IXSignAttachedTS interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedTSItem();

Az aláíráshoz tartozó következő időbélyeg adatainak az interfészét tudjuk lekérni. A GetFirstAttachedTSItem() metódussal együtt használva végigiterálhatunk az összes időbélyegen.

Visszatérési érték:

Egy IXSignAttachedTS interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetFirstAttachedCRLItem();

Az aláíráshoz tartozó első tanúsítvány visszavonási lista adatainak az interfészét tudjuk lekérni. A GetNextAttachedCRLItem() metódussal együtt használva végigiterálhatunk az összes tanúsítvány visszavonási listán.

Visszatérési érték:

Egy IXSignAttachedCRL interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedCRLItem();

Az aláíráshoz tartozó következő tanúsítvány visszavonási lista adatainak az interfészét tudjuk lekérni. A GetFirstAttachedCRLItem() metódussal együtt használva végigiterálhatunk az összes tanúsítvány visszavonási listán.

Visszatérési érték:

Egy IXSignAttachedCRL interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetFirstAttachedCertificateItem();

Az aláíráshoz tartozó első hitelesítés-szolgáltató tanúsítvány adatainak az interfészét tudjuk lekérni. A GetNextAttachedCertificateItem() metódussal együtt használva végigiterálhatunk az összes tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedCRL interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedCertificateItem();

Az aláíráshoz tartozó következő hitelesítés-szolgáltató tanúsítvány adatainak az interfészét tudjuk lekérni. A GetFirstAttachedCertificateItem() metódussal együtt használva végigiterálhatunk az összes tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedCertificate interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetFirstAttachedOCSPItem();

Az aláíráshoz tartozó első OCSP válasz adatainak az interfészét tudjuk lekérni. A GetNextAttachedOCSPItem() metódussal együtt használva végigiterálhatunk az összes OCSP válaszon.

Visszatérési érték:

Egy IXSignAttachedOCSP interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedOCSPItem();

Az aláíráshoz tartozó következő OCSP válasz adatainak az interfészét tudjuk lekérni. A GetFirstAttachedOCSPItem() metódussal együtt használva végig iterálhatunk az összes OCSP válaszon.

Visszatérési érték:

Egy IXSignAttachedOCSP interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

IDispatch * GetFirstAttachedAttributeCertificateItem();

Az aláíráshoz tartozó első csatolt attribútum tanúsítvány adatainak az interfészét tudjuk lekérni. A GetNextAttachedAttributeCertificateItem() metódussal együtt használva végigiterálhatunk az összes csatolt attribútum tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedAttributeCertificate interfészre mutató pointer. Sikertelen lekérdezés esetén NULL a pointer értéke.

IDispatch * GetNextAttachedAttributeCertificateItem();

Az aláíráshoz tartozó következő csatolt attribútum tanúsítvány adatainak az interfészét tudjuk lekérni. A GetFirstAttachedAttributeCertificateItem() metódussal együtt használva végig iterálhatunk az csatolt attribútum tanúsítványon.

Visszatérési érték:

Egy IXSignAttachedAttributeCertificate interfészre mutató pointer. Sikertelen lekérdezés esetén, vagy ha vége az iterálásnak, akkor NULL a pointer értéke.

BSTR GetUnsignedHash();

Ez a metódus a félig kész aláírásból kinyeri az aláíratlan lenyomatot.

Az elosztott aláírás készítés részleteiről a IXSignDossier::SetSignedHash() függvény leírásában olvashat.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Visszatérési érték:

A base64 kódolt aláíratlan lenyomatot tartalmazó string.

LONG SetSignedHash(BSTR hash);

Ez a metódus a félig kész aláírásba helyezi az aláírt lenyomatot.

Az elosztott aláírás készítés részleteiről a IXSignDossier::SetSignedHash() függvény leírásában olvashat.

Megjegyzés:

Windows CE operációs rendszeren nem támogatott ez a funkció.

Paraméterek:

• BSTR hash – Bemeneti paraméter. A base64 kódolt aláírt lenyomat.

Visszatérési érték:

Az XSign visszatérési értéke (lásd XSign visszatérési értékek című alfejezet). Sikeres művelet esetén a visszatérési érték 0 (XSR_OK).

BSTR GetSignatureID();

Visszaadja az aláírás azonosítóját.

Visszatérési érték:

Az aláírás azonosítóját tartalmazó string.

BSTR GetSignerRole();

Visszaadja az aláíró szerepét.

Visszatérési érték:

Az aláíró szerepét tartalmazó string.

BSTR GetAdESVersion();

Visszaadja, hogy az aláírás melyik CAdES/XAdES verziónak felel meg.

Visszatérési érték:

A verziót jelentő string.

IDispatch * GetSignProperties();

E metódus visszaadja az aláíráshoz tartozó tovább aláírói tulajdonságokat egy IXSignSignProperties objektumban.

Visszatérési érték:

IXSignSignProperties objektum

IDispatch * GetQCResult();

E metódus az aláírói tanúsítvány minősítéséről ad hasznos információt egy IXSignQCResult interfésszel lekérdezhető objektumban.

Visszatérési érték:

IXSignQCResult objektum

LONG GetMainType();

Visszaadja az aláírás belső típusát

A visszatérési értékeket lásd az IXSignSignature::GetMainType leírásánál.

BSTR GetIdentifier();

Visszaadja az aláírás azonosítóját.

Visszatérési érték:

Az aláírás azonosítóját tartalmazó string.

BSTR GetSignatureAlgorithm();

Visszaadja az aláíró algoritmus nevét.

Visszatérési érték:

Az aláíró algoritmus nevét tartalmazó string.

BSTR GetSignatureKeyDescription();

Visszaadja az aláíró kulcs leírását szöveges formában.

Visszatérési érték:

Az aláíró kulcs leírását tartalmazó string.

BSTR GetCertSignAlgorithm();

Visszaadja az aláíró tanúsítvány aláírásához használt algoritmus nevét.

Visszatérési érték:

Az aláíró tanúsítvány aláírásához használt algoritmus nevét tartalmazó string.

BSTR GetOrganizationIdentifier();

E metódus visszaadja, aláírói tanúsítvány szervezeti azonosítóját.

Visszatérési érték:

Az aláírói tanúsítvány szervezeti azonosítóját tartalmazó string.