H-Sphere Developer Guide

H-Sphere XML API: PGP Services

 

Related Docs:  

H-Sphere XML API Reference

Actions:

 

Action: getKeyPair

Description: generates and returns PGP key pair (public key + private key).

Parameters:

AuthToken:at - authentication information.
String:identification - key's identification.
String:subkeyIdentification - sub-key's identification.
String:encryptPhrase - PGP code phrase.

Response: private and public keys.

Example:

 <soapenv:Body>
  <ns1:getKeyPair soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <at href="#id0"/>
   <identification xsi:type="xsd:string">main identification string</identification>
   <subkeyIdentification xsi:type="xsd:string">identification string for subkey</subkeyIdentification>
   <encryptPhrase xsi:type="xsd:string">private PGP code phrase</encryptPhrase>
  </ns1:getKeyPair>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:PGPServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:getKeyPairResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <getKeyPairReturn href="#id0"/>
  </ns1:getKeyPairResponse>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:PGPKeysInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:PGPServices">
   <encryptPhrase xsi:type="xsd:string">private PGP code phrase</encryptPhrase>
   <privateKey xsi:type="xsd:string">-----BEGIN PGP PRIVATE KEY BLOCK-----
Version: Cryptix OpenPGP 0.20030205

lQHPBEBXSxgRBAD9f1OBHXUSKVLfSpwu7OTn9hG3UjzvRADDHj+AtlEmaUVdQCJR
+1k9jVj6v8X1ujD2y5tVbNeBO4AdNG/yZmC3a5lQpaSfn+gEexAiwk+7qdf+t8Yb
+DtX58aophUPBPuD9tPFHsMCNVQTWhaRMvZ1864rYdcq7/IiAxmd0UgBxwCgl2BQ
jxUjC8yykrmCouuEC/BYHPUEAPfhoIXWmz3ey7yrXDa4V7l5lK+7+jrqgvlXTAs9
B4JnUVlXjrrUWU/mcQcQgYC0SRZxI+hMKBYTt88JMozIpuE8FnqLVHyNKOCjrh4r
s6Z1kW6jfwv6ITVi8ftiegEkO8yk8b6oUZCJqIPf4VrlnwaSi2ZegHtVJWQBTDv+
z0kqA/9TTbmyisUqj+uc/ibvpevga9eApJnaAwU8wGOy+iAXrS1gXH36OcciwN+K
ZxuqkIDBjb+8hfJchE9754lCtlVIrJvsJ1sIpmXfO9IMt9X1RmTkPWnOhZHjdsXs
E1qc2cnR2y9juQtQxTRm2c5xLUdDbj6c9EWD/5ytI0ubPZVY2v8DAwJLaDRvh0i+
J5Z9lwAmC/0He+8TeimqAdgg8XQkvTFoWZp5c0l01aIhJ7QabWFpbiBpZGVudGlm
aWNhdGlvbiBzdHJpbmeIVgQTEQIAFgUCQFdLGAYLBwgJAwIDFQIDBBYCAQAACgkQ
xRAHgGCXJC00OwCeM/jlndMj+/bYOfPutr3duuEztJ4AnA5joMEGNBKLFSENBBYQ
RflD82xPtCBpZGVudGlmaWNhdGlvbiBzdHJpbmcgZm9yIHN1YmtleYhWBBMRAgAW
BQJAV0sYBgsHCAkDAgMVAgMEFgIBAAAKCRDFEAeAYJckLemgAJ4/yMMDfbXnn0tx
kZ4tZmzqxe5degCeNc/PtfuNzVLcd8J+mJ7v+4IWAuCdAaYEQFdLGBAEAP//////
////yQ/aoiFowjTExmKLgNwc0SkCTgiKZ8x0Agu+pjsTmyJRSgh5jjQE3e+VGbPN
OkMbMCsKbfJfFDdP4TVtbVHCReSFtXZiXn7G9ExC6aY37WsL/1y29Aa37e44a/ta
iZ+lrp8kEXxLH+ZJKGZR7OZTgf//////////AAICBADGTvf0GdCjqffoN+j6WA5D
OM8Z7dbSFBOAWVAXg+skqZ9jcNiH2PaMPjH4xiQ8710+XZXZSebvI4qovYyAKOxJ
mgwsRCEytrYBHUos99XtQdExlqK4lMtm1hD62d0Lx+9KAP6Kxg3XD0V0GjLhji1E
REkPACqg/TBlE1p07r6ZBP8DAwKfGyMvJz4HapaS3/TpqNXUkWvqvBDCUpYodtb8
STvtdLu7tKESg5cUopZDE/yUpaAkx+1j+UQJWPVenvS9eupR0EnJSjgJxgBbObUg
8RT4zPB7KQv17rAUPVzWw+cirmAnnJ/vTfAYuJ8Bolgl+PcKZXsO9cDN/HC8MKmJ
jiFFmipb3lhscMKt24g9o5a7md9r3ainpYhGBBgRAgAGBQJAV0sYAAoJEMUQB4Bg
lyQtJioAnj5jl4+GI4yAmyWgpTsCwtBnPJGJAJ0a2O1eAwd5/UAVkNNuYuspcLQs
lg==
=UDtD
-----END PGP PRIVATE KEY BLOCK-----
</privateKey>
   <publicKey xsi:type="xsd:string">-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: Cryptix OpenPGP 0.20030205

mQGiBEBXSxgRBAD9f1OBHXUSKVLfSpwu7OTn9hG3UjzvRADDHj+AtlEmaUVdQCJR
+1k9jVj6v8X1ujD2y5tVbNeBO4AdNG/yZmC3a5lQpaSfn+gEexAiwk+7qdf+t8Yb
+DtX58aophUPBPuD9tPFHsMCNVQTWhaRMvZ1864rYdcq7/IiAxmd0UgBxwCgl2BQ
jxUjC8yykrmCouuEC/BYHPUEAPfhoIXWmz3ey7yrXDa4V7l5lK+7+jrqgvlXTAs9
B4JnUVlXjrrUWU/mcQcQgYC0SRZxI+hMKBYTt88JMozIpuE8FnqLVHyNKOCjrh4r
s6Z1kW6jfwv6ITVi8ftiegEkO8yk8b6oUZCJqIPf4VrlnwaSi2ZegHtVJWQBTDv+
z0kqA/9TTbmyisUqj+uc/ibvpevga9eApJnaAwU8wGOy+iAXrS1gXH36OcciwN+K
ZxuqkIDBjb+8hfJchE9754lCtlVIrJvsJ1sIpmXfO9IMt9X1RmTkPWnOhZHjdsXs
E1qc2cnR2y9juQtQxTRm2c5xLUdDbj6c9EWD/5ytI0ubPZVY2rQabWFpbiBpZGVu
dGlmaWNhdGlvbiBzdHJpbmeIVgQTEQIAFgUCQFdLGAYLBwgJAwIDFQIDBBYCAQAA
CgkQxRAHgGCXJC00OwCeM/jlndMj+/bYOfPutr3duuEztJ4AnA5joMEGNBKLFSEN
BBYQRflD82xPtCBpZGVudGlmaWNhdGlvbiBzdHJpbmcgZm9yIHN1YmtleYhWBBMR
AgAWBQJAV0sYBgsHCAkDAgMVAgMEFgIBAAAKCRDFEAeAYJckLemgAJ4/yMMDfbXn
n0txkZ4tZmzqxe5degCeNc/PtfuNzVLcd8J+mJ7v+4IWAuC5AQ0EQFdLGBAEAP//
////////yQ/aoiFowjTExmKLgNwc0SkCTgiKZ8x0Agu+pjsTmyJRSgh5jjQE3e+V
GbPNOkMbMCsKbfJfFDdP4TVtbVHCReSFtXZiXn7G9ExC6aY37WsL/1y29Aa37e44
a/taiZ+lrp8kEXxLH+ZJKGZR7OZTgf//////////AAICBADGTvf0GdCjqffoN+j6
WA5DOM8Z7dbSFBOAWVAXg+skqZ9jcNiH2PaMPjH4xiQ8710+XZXZSebvI4qovYyA
KOxJmgwsRCEytrYBHUos99XtQdExlqK4lMtm1hD62d0Lx+9KAP6Kxg3XD0V0GjLh
ji1EREkPACqg/TBlE1p07r6ZBIhGBBgRAgAGBQJAV0sYAAoJEMUQB4BglyQtJioA
nj5jl4+GI4yAmyWgpTsCwtBnPJGJAJ0a2O1eAwd5/UAVkNNuYuspcLQslg==
=oGCg
-----END PGP PUBLIC KEY BLOCK-----
</publicKey>
  </multiRef>
 </soapenv:Body>

 

Action: encrypt

Description: encrypts message.

Parameters:

AuthToken:at - authentication information.
String:message - message to encrypt.
String:publicKey - public key.

Response: encrypted message.

Example:

<soapenv:Body>
  <ns1:encrypt soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <at href="#id0"/>
   <message xsi:type="xsd:string">My message</message>
   <publicKey xsi:type="xsd:string">-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: Cryptix OpenPGP 0.20030205

mQGiBEBXSxgRBAD9f1OBHXUSKVLfSpwu7OTn9hG3UjzvRADDHj+AtlEmaUVdQCJR
+1k9jVj6v8X1ujD2y5tVbNeBO4AdNG/yZmC3a5lQpaSfn+gEexAiwk+7qdf+t8Yb
+DtX58aophUPBPuD9tPFHsMCNVQTWhaRMvZ1864rYdcq7/IiAxmd0UgBxwCgl2BQ
jxUjC8yykrmCouuEC/BYHPUEAPfhoIXWmz3ey7yrXDa4V7l5lK+7+jrqgvlXTAs9
B4JnUVlXjrrUWU/mcQcQgYC0SRZxI+hMKBYTt88JMozIpuE8FnqLVHyNKOCjrh4r
s6Z1kW6jfwv6ITVi8ftiegEkO8yk8b6oUZCJqIPf4VrlnwaSi2ZegHtVJWQBTDv+
z0kqA/9TTbmyisUqj+uc/ibvpevga9eApJnaAwU8wGOy+iAXrS1gXH36OcciwN+K
ZxuqkIDBjb+8hfJchE9754lCtlVIrJvsJ1sIpmXfO9IMt9X1RmTkPWnOhZHjdsXs
E1qc2cnR2y9juQtQxTRm2c5xLUdDbj6c9EWD/5ytI0ubPZVY2rQabWFpbiBpZGVu
dGlmaWNhdGlvbiBzdHJpbmeIVgQTEQIAFgUCQFdLGAYLBwgJAwIDFQIDBBYCAQAA
CgkQxRAHgGCXJC00OwCeM/jlndMj+/bYOfPutr3duuEztJ4AnA5joMEGNBKLFSEN
BBYQRflD82xPtCBpZGVudGlmaWNhdGlvbiBzdHJpbmcgZm9yIHN1YmtleYhWBBMR
AgAWBQJAV0sYBgsHCAkDAgMVAgMEFgIBAAAKCRDFEAeAYJckLemgAJ4/yMMDfbXn
n0txkZ4tZmzqxe5degCeNc/PtfuNzVLcd8J+mJ7v+4IWAuC5AQ0EQFdLGBAEAP//
////////yQ/aoiFowjTExmKLgNwc0SkCTgiKZ8x0Agu+pjsTmyJRSgh5jjQE3e+V
GbPNOkMbMCsKbfJfFDdP4TVtbVHCReSFtXZiXn7G9ExC6aY37WsL/1y29Aa37e44
a/taiZ+lrp8kEXxLH+ZJKGZR7OZTgf//////////AAICBADGTvf0GdCjqffoN+j6
WA5DOM8Z7dbSFBOAWVAXg+skqZ9jcNiH2PaMPjH4xiQ8710+XZXZSebvI4qovYyA
KOxJmgwsRCEytrYBHUos99XtQdExlqK4lMtm1hD62d0Lx+9KAP6Kxg3XD0V0GjLh
ji1EREkPACqg/TBlE1p07r6ZBIhGBBgRAgAGBQJAV0sYAAoJEMUQB4BglyQtJioA
nj5jl4+GI4yAmyWgpTsCwtBnPJGJAJ0a2O1eAwd5/UAVkNNuYuspcLQslg==
=oGCg
-----END PGP PUBLIC KEY BLOCK-----
</publicKey>
  </ns1:encrypt>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:PGPServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:encryptResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <encryptReturn xsi:type="xsd:string">-----BEGIN PGP MESSAGE-----
Version: Cryptix OpenPGP 0.20030205

hQEOA7zq9S7fBtfhEAP/fNn/j7NXinjlptVaWlusyi5sDPYcQHnMn4+68977qwQY
K/+i9SZ6MfMdyckEtLmIyD7VbDpmKF4Q8Iy3rN7+xuL0XqBI7tKepJwyePAW+RTG
fj1AfGRwS4Hg/lwGKRRC6dk5fK3w/M2w/yQz3m3QAy4XUD90/ekit3vW+mGITIQD
/3bUHIOFSZPyz7TmFaHRinA85Oy4C/mjL4PhnJPk4p/mtNKMLBTxNjnqhXj4iPMs
ExlnUAJul53Km7+a1l9i/cKM7HzvPInPqkjuBrTXhndGpneCH1sxbckba0Iiq1Yn
ilp40gGLPZCxs8LIHFvAmSS5RmPgFP2YYFgGXt3xzhTfpB4zWPHevxXKRkOeDdqX
GKZwqqp/fdiIgzttKkTP4bQ=
=Wzrv
-----END PGP MESSAGE-----
</encryptReturn>
  </ns1:encryptResponse>
 </soapenv:Body>

 

Action: decrypt

Description: decrypts message.

Parameters:

AuthToken:at - authentication information.
String:message - message to decrypt.
String:privateKey - private key.
String encryptPhrase - PGP code phrase.

Response: decrypted message.

Example:

<soapenv:Body>
  <ns1:decrypt soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <at href="#id0"/>
   <message xsi:type="xsd:string">-----BEGIN PGP MESSAGE-----
Version: Cryptix OpenPGP 0.20030205

hQEOA7zq9S7fBtfhEAP/fNn/j7NXinjlptVaWlusyi5sDPYcQHnMn4+68977qwQY
K/+i9SZ6MfMdyckEtLmIyD7VbDpmKF4Q8Iy3rN7+xuL0XqBI7tKepJwyePAW+RTG
fj1AfGRwS4Hg/lwGKRRC6dk5fK3w/M2w/yQz3m3QAy4XUD90/ekit3vW+mGITIQD
/3bUHIOFSZPyz7TmFaHRinA85Oy4C/mjL4PhnJPk4p/mtNKMLBTxNjnqhXj4iPMs
ExlnUAJul53Km7+a1l9i/cKM7HzvPInPqkjuBrTXhndGpneCH1sxbckba0Iiq1Yn
ilp40gGLPZCxs8LIHFvAmSS5RmPgFP2YYFgGXt3xzhTfpB4zWPHevxXKRkOeDdqX
GKZwqqp/fdiIgzttKkTP4bQ=
=Wzrv
-----END PGP MESSAGE-----
</message>
   <privateKey xsi:type="xsd:string">-----BEGIN PGP PRIVATE KEY BLOCK-----
Version: Cryptix OpenPGP 0.20030205

lQHPBEBXSxgRBAD9f1OBHXUSKVLfSpwu7OTn9hG3UjzvRADDHj+AtlEmaUVdQCJR
+1k9jVj6v8X1ujD2y5tVbNeBO4AdNG/yZmC3a5lQpaSfn+gEexAiwk+7qdf+t8Yb
+DtX58aophUPBPuD9tPFHsMCNVQTWhaRMvZ1864rYdcq7/IiAxmd0UgBxwCgl2BQ
jxUjC8yykrmCouuEC/BYHPUEAPfhoIXWmz3ey7yrXDa4V7l5lK+7+jrqgvlXTAs9
B4JnUVlXjrrUWU/mcQcQgYC0SRZxI+hMKBYTt88JMozIpuE8FnqLVHyNKOCjrh4r
s6Z1kW6jfwv6ITVi8ftiegEkO8yk8b6oUZCJqIPf4VrlnwaSi2ZegHtVJWQBTDv+
z0kqA/9TTbmyisUqj+uc/ibvpevga9eApJnaAwU8wGOy+iAXrS1gXH36OcciwN+K
ZxuqkIDBjb+8hfJchE9754lCtlVIrJvsJ1sIpmXfO9IMt9X1RmTkPWnOhZHjdsXs
E1qc2cnR2y9juQtQxTRm2c5xLUdDbj6c9EWD/5ytI0ubPZVY2v8DAwJLaDRvh0i+
J5Z9lwAmC/0He+8TeimqAdgg8XQkvTFoWZp5c0l01aIhJ7QabWFpbiBpZGVudGlm
aWNhdGlvbiBzdHJpbmeIVgQTEQIAFgUCQFdLGAYLBwgJAwIDFQIDBBYCAQAACgkQ
xRAHgGCXJC00OwCeM/jlndMj+/bYOfPutr3duuEztJ4AnA5joMEGNBKLFSENBBYQ
RflD82xPtCBpZGVudGlmaWNhdGlvbiBzdHJpbmcgZm9yIHN1YmtleYhWBBMRAgAW
BQJAV0sYBgsHCAkDAgMVAgMEFgIBAAAKCRDFEAeAYJckLemgAJ4/yMMDfbXnn0tx
kZ4tZmzqxe5degCeNc/PtfuNzVLcd8J+mJ7v+4IWAuCdAaYEQFdLGBAEAP//////
////yQ/aoiFowjTExmKLgNwc0SkCTgiKZ8x0Agu+pjsTmyJRSgh5jjQE3e+VGbPN
OkMbMCsKbfJfFDdP4TVtbVHCReSFtXZiXn7G9ExC6aY37WsL/1y29Aa37e44a/ta
iZ+lrp8kEXxLH+ZJKGZR7OZTgf//////////AAICBADGTvf0GdCjqffoN+j6WA5D
OM8Z7dbSFBOAWVAXg+skqZ9jcNiH2PaMPjH4xiQ8710+XZXZSebvI4qovYyAKOxJ
mgwsRCEytrYBHUos99XtQdExlqK4lMtm1hD62d0Lx+9KAP6Kxg3XD0V0GjLhji1E
REkPACqg/TBlE1p07r6ZBP8DAwKfGyMvJz4HapaS3/TpqNXUkWvqvBDCUpYodtb8
STvtdLu7tKESg5cUopZDE/yUpaAkx+1j+UQJWPVenvS9eupR0EnJSjgJxgBbObUg
8RT4zPB7KQv17rAUPVzWw+cirmAnnJ/vTfAYuJ8Bolgl+PcKZXsO9cDN/HC8MKmJ
jiFFmipb3lhscMKt24g9o5a7md9r3ainpYhGBBgRAgAGBQJAV0sYAAoJEMUQB4Bg
lyQtJioAnj5jl4+GI4yAmyWgpTsCwtBnPJGJAJ0a2O1eAwd5/UAVkNNuYuspcLQs
lg==
=UDtD
-----END PGP PRIVATE KEY BLOCK-----
</privateKey>
   <encryptPhrase xsi:type="xsd:string">private PGP code phrase</encryptPhrase>
  </ns1:decrypt>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:PGPServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:decryptResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <decryptReturn xsi:type="xsd:string">My message </decryptReturn>
  </ns1:decryptResponse>
 </soapenv:Body>

 

Action: verifyMessage

Description: verifies whether the message is valid.

Parameters:

AuthToken:at - authentication information.
String:message - message to verify.
String:publicKey - public key.

Response: valid message.

Example:

<soapenv:Body>
  <ns1:verifyMessage soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <at href="#id0"/>
   <message xsi:type="xsd:string">-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

- -----BEGIN PGP MESSAGE-----
Version: Cryptix OpenPGP 0.20030205

hQEOA7zq9S7fBtfhEAP/fNn/j7NXinjlptVaWlusyi5sDPYcQHnMn4+68977qwQY
K/+i9SZ6MfMdyckEtLmIyD7VbDpmKF4Q8Iy3rN7+xuL0XqBI7tKepJwyePAW+RTG
fj1AfGRwS4Hg/lwGKRRC6dk5fK3w/M2w/yQz3m3QAy4XUD90/ekit3vW+mGITIQD
/3bUHIOFSZPyz7TmFaHRinA85Oy4C/mjL4PhnJPk4p/mtNKMLBTxNjnqhXj4iPMs
ExlnUAJul53Km7+a1l9i/cKM7HzvPInPqkjuBrTXhndGpneCH1sxbckba0Iiq1Yn
ilp40gGLPZCxs8LIHFvAmSS5RmPgFP2YYFgGXt3xzhTfpB4zWPHevxXKRkOeDdqX
GKZwqqp/fdiIgzttKkTP4bQ=
=Wzrv
- -----END PGP MESSAGE-----

-----BEGIN PGP SIGNATURE-----
Version: Cryptix OpenPGP 0.20030205

iEYEARECAAYFAkBXSxkACgkQxRAHgGCXJC041wCgiAloP612EIe/RBOAaj0f93G5
CaIAnjgADy0zY9sXN1H1qFpw6pZhf0BR
=B5eR
-----END PGP SIGNATURE-----
</message>
   <publicKey xsi:type="xsd:string">-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: Cryptix OpenPGP 0.20030205

mQGiBEBXSxgRBAD9f1OBHXUSKVLfSpwu7OTn9hG3UjzvRADDHj+AtlEmaUVdQCJR
+1k9jVj6v8X1ujD2y5tVbNeBO4AdNG/yZmC3a5lQpaSfn+gEexAiwk+7qdf+t8Yb
+DtX58aophUPBPuD9tPFHsMCNVQTWhaRMvZ1864rYdcq7/IiAxmd0UgBxwCgl2BQ
jxUjC8yykrmCouuEC/BYHPUEAPfhoIXWmz3ey7yrXDa4V7l5lK+7+jrqgvlXTAs9
B4JnUVlXjrrUWU/mcQcQgYC0SRZxI+hMKBYTt88JMozIpuE8FnqLVHyNKOCjrh4r
s6Z1kW6jfwv6ITVi8ftiegEkO8yk8b6oUZCJqIPf4VrlnwaSi2ZegHtVJWQBTDv+
z0kqA/9TTbmyisUqj+uc/ibvpevga9eApJnaAwU8wGOy+iAXrS1gXH36OcciwN+K
ZxuqkIDBjb+8hfJchE9754lCtlVIrJvsJ1sIpmXfO9IMt9X1RmTkPWnOhZHjdsXs
E1qc2cnR2y9juQtQxTRm2c5xLUdDbj6c9EWD/5ytI0ubPZVY2rQabWFpbiBpZGVu
dGlmaWNhdGlvbiBzdHJpbmeIVgQTEQIAFgUCQFdLGAYLBwgJAwIDFQIDBBYCAQAA
CgkQxRAHgGCXJC00OwCeM/jlndMj+/bYOfPutr3duuEztJ4AnA5joMEGNBKLFSEN
BBYQRflD82xPtCBpZGVudGlmaWNhdGlvbiBzdHJpbmcgZm9yIHN1YmtleYhWBBMR
AgAWBQJAV0sYBgsHCAkDAgMVAgMEFgIBAAAKCRDFEAeAYJckLemgAJ4/yMMDfbXn
n0txkZ4tZmzqxe5degCeNc/PtfuNzVLcd8J+mJ7v+4IWAuC5AQ0EQFdLGBAEAP//
////////yQ/aoiFowjTExmKLgNwc0SkCTgiKZ8x0Agu+pjsTmyJRSgh5jjQE3e+V
GbPNOkMbMCsKbfJfFDdP4TVtbVHCReSFtXZiXn7G9ExC6aY37WsL/1y29Aa37e44
a/taiZ+lrp8kEXxLH+ZJKGZR7OZTgf//////////AAICBADGTvf0GdCjqffoN+j6
WA5DOM8Z7dbSFBOAWVAXg+skqZ9jcNiH2PaMPjH4xiQ8710+XZXZSebvI4qovYyA
KOxJmgwsRCEytrYBHUos99XtQdExlqK4lMtm1hD62d0Lx+9KAP6Kxg3XD0V0GjLh
ji1EREkPACqg/TBlE1p07r6ZBIhGBBgRAgAGBQJAV0sYAAoJEMUQB4BglyQtJioA
nj5jl4+GI4yAmyWgpTsCwtBnPJGJAJ0a2O1eAwd5/UAVkNNuYuspcLQslg==
=oGCg
-----END PGP PUBLIC KEY BLOCK-----
</publicKey>
  </ns1:verifyMessage>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:PGPServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:verifyMessageResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <verifyMessageReturn xsi:type="xsd:boolean">true</verifyMessageReturn>
  </ns1:verifyMessageResponse>
 </soapenv:Body>

 

Action: signMessage

Description: signs the message.

Parameters:

AuthToken:at - authentication information.
String:message - message to sign.
String:privateKey - private key.
String:encryptPhrase - PGP code phrase.

Response: signed message.

Example:

 <soapenv:Body>
  <ns1:signMessage soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <at href="#id0"/>
   <message xsi:type="xsd:string">-----BEGIN PGP MESSAGE-----
Version: Cryptix OpenPGP 0.20030205

hQEOA7zq9S7fBtfhEAP/fNn/j7NXinjlptVaWlusyi5sDPYcQHnMn4+68977qwQY
K/+i9SZ6MfMdyckEtLmIyD7VbDpmKF4Q8Iy3rN7+xuL0XqBI7tKepJwyePAW+RTG
fj1AfGRwS4Hg/lwGKRRC6dk5fK3w/M2w/yQz3m3QAy4XUD90/ekit3vW+mGITIQD
/3bUHIOFSZPyz7TmFaHRinA85Oy4C/mjL4PhnJPk4p/mtNKMLBTxNjnqhXj4iPMs
ExlnUAJul53Km7+a1l9i/cKM7HzvPInPqkjuBrTXhndGpneCH1sxbckba0Iiq1Yn
ilp40gGLPZCxs8LIHFvAmSS5RmPgFP2YYFgGXt3xzhTfpB4zWPHevxXKRkOeDdqX
GKZwqqp/fdiIgzttKkTP4bQ=
=Wzrv
-----END PGP MESSAGE-----
</message>
   <privateKey xsi:type="xsd:string">-----BEGIN PGP PRIVATE KEY BLOCK-----
Version: Cryptix OpenPGP 0.20030205

lQHPBEBXSxgRBAD9f1OBHXUSKVLfSpwu7OTn9hG3UjzvRADDHj+AtlEmaUVdQCJR
+1k9jVj6v8X1ujD2y5tVbNeBO4AdNG/yZmC3a5lQpaSfn+gEexAiwk+7qdf+t8Yb
+DtX58aophUPBPuD9tPFHsMCNVQTWhaRMvZ1864rYdcq7/IiAxmd0UgBxwCgl2BQ
jxUjC8yykrmCouuEC/BYHPUEAPfhoIXWmz3ey7yrXDa4V7l5lK+7+jrqgvlXTAs9
B4JnUVlXjrrUWU/mcQcQgYC0SRZxI+hMKBYTt88JMozIpuE8FnqLVHyNKOCjrh4r
s6Z1kW6jfwv6ITVi8ftiegEkO8yk8b6oUZCJqIPf4VrlnwaSi2ZegHtVJWQBTDv+
z0kqA/9TTbmyisUqj+uc/ibvpevga9eApJnaAwU8wGOy+iAXrS1gXH36OcciwN+K
ZxuqkIDBjb+8hfJchE9754lCtlVIrJvsJ1sIpmXfO9IMt9X1RmTkPWnOhZHjdsXs
E1qc2cnR2y9juQtQxTRm2c5xLUdDbj6c9EWD/5ytI0ubPZVY2v8DAwJLaDRvh0i+
J5Z9lwAmC/0He+8TeimqAdgg8XQkvTFoWZp5c0l01aIhJ7QabWFpbiBpZGVudGlm
aWNhdGlvbiBzdHJpbmeIVgQTEQIAFgUCQFdLGAYLBwgJAwIDFQIDBBYCAQAACgkQ
xRAHgGCXJC00OwCeM/jlndMj+/bYOfPutr3duuEztJ4AnA5joMEGNBKLFSENBBYQ
RflD82xPtCBpZGVudGlmaWNhdGlvbiBzdHJpbmcgZm9yIHN1YmtleYhWBBMRAgAW
BQJAV0sYBgsHCAkDAgMVAgMEFgIBAAAKCRDFEAeAYJckLemgAJ4/yMMDfbXnn0tx
kZ4tZmzqxe5degCeNc/PtfuNzVLcd8J+mJ7v+4IWAuCdAaYEQFdLGBAEAP//////
////yQ/aoiFowjTExmKLgNwc0SkCTgiKZ8x0Agu+pjsTmyJRSgh5jjQE3e+VGbPN
OkMbMCsKbfJfFDdP4TVtbVHCReSFtXZiXn7G9ExC6aY37WsL/1y29Aa37e44a/ta
iZ+lrp8kEXxLH+ZJKGZR7OZTgf//////////AAICBADGTvf0GdCjqffoN+j6WA5D
OM8Z7dbSFBOAWVAXg+skqZ9jcNiH2PaMPjH4xiQ8710+XZXZSebvI4qovYyAKOxJ
mgwsRCEytrYBHUos99XtQdExlqK4lMtm1hD62d0Lx+9KAP6Kxg3XD0V0GjLhji1E
REkPACqg/TBlE1p07r6ZBP8DAwKfGyMvJz4HapaS3/TpqNXUkWvqvBDCUpYodtb8
STvtdLu7tKESg5cUopZDE/yUpaAkx+1j+UQJWPVenvS9eupR0EnJSjgJxgBbObUg
8RT4zPB7KQv17rAUPVzWw+cirmAnnJ/vTfAYuJ8Bolgl+PcKZXsO9cDN/HC8MKmJ
jiFFmipb3lhscMKt24g9o5a7md9r3ainpYhGBBgRAgAGBQJAV0sYAAoJEMUQB4Bg
lyQtJioAnj5jl4+GI4yAmyWgpTsCwtBnPJGJAJ0a2O1eAwd5/UAVkNNuYuspcLQs
lg==
=UDtD
-----END PGP PRIVATE KEY BLOCK-----
</privateKey>
   <encryptPhrase xsi:type="xsd:string">private PGP code phrase</encryptPhrase>
  </ns1:signMessage>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:PGPServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:signMessageResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <signMessageReturn xsi:type="xsd:string">-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

- -----BEGIN PGP MESSAGE-----
Version: Cryptix OpenPGP 0.20030205

hQEOA7zq9S7fBtfhEAP/fNn/j7NXinjlptVaWlusyi5sDPYcQHnMn4+68977qwQY
K/+i9SZ6MfMdyckEtLmIyD7VbDpmKF4Q8Iy3rN7+xuL0XqBI7tKepJwyePAW+RTG
fj1AfGRwS4Hg/lwGKRRC6dk5fK3w/M2w/yQz3m3QAy4XUD90/ekit3vW+mGITIQD
/3bUHIOFSZPyz7TmFaHRinA85Oy4C/mjL4PhnJPk4p/mtNKMLBTxNjnqhXj4iPMs
ExlnUAJul53Km7+a1l9i/cKM7HzvPInPqkjuBrTXhndGpneCH1sxbckba0Iiq1Yn
ilp40gGLPZCxs8LIHFvAmSS5RmPgFP2YYFgGXt3xzhTfpB4zWPHevxXKRkOeDdqX
GKZwqqp/fdiIgzttKkTP4bQ=
=Wzrv
- -----END PGP MESSAGE-----

-----BEGIN PGP SIGNATURE-----
Version: Cryptix OpenPGP 0.20030205

iEYEARECAAYFAkBXSxkACgkQxRAHgGCXJC041wCgiAloP612EIe/RBOAaj0f93G5
CaIAnjgADy0zY9sXN1H1qFpw6pZhf0BR
=B5eR
-----END PGP SIGNATURE-----
</signMessageReturn>
  </ns1:signMessageResponse>
 </soapenv:Body>

 

Action: unsignMessage

Description: unsigns the message.

Parameters:

AuthToken:at - authentication information.
String:message - message to unsign.

Response: unsigned message.

Example:

 <soapenv:Body>
  <ns1:unsignMessage soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <at href="#id0"/>
   <message xsi:type="xsd:string">-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

- -----BEGIN PGP MESSAGE-----
Version: Cryptix OpenPGP 0.20030205

hQEOA7zq9S7fBtfhEAP/fNn/j7NXinjlptVaWlusyi5sDPYcQHnMn4+68977qwQY
K/+i9SZ6MfMdyckEtLmIyD7VbDpmKF4Q8Iy3rN7+xuL0XqBI7tKepJwyePAW+RTG
fj1AfGRwS4Hg/lwGKRRC6dk5fK3w/M2w/yQz3m3QAy4XUD90/ekit3vW+mGITIQD
/3bUHIOFSZPyz7TmFaHRinA85Oy4C/mjL4PhnJPk4p/mtNKMLBTxNjnqhXj4iPMs
ExlnUAJul53Km7+a1l9i/cKM7HzvPInPqkjuBrTXhndGpneCH1sxbckba0Iiq1Yn
ilp40gGLPZCxs8LIHFvAmSS5RmPgFP2YYFgGXt3xzhTfpB4zWPHevxXKRkOeDdqX
GKZwqqp/fdiIgzttKkTP4bQ=
=Wzrv
- -----END PGP MESSAGE-----

-----BEGIN PGP SIGNATURE-----
Version: Cryptix OpenPGP 0.20030205

iEYEARECAAYFAkBXSxkACgkQxRAHgGCXJC041wCgiAloP612EIe/RBOAaj0f93G5
CaIAnjgADy0zY9sXN1H1qFpw6pZhf0BR
=B5eR
-----END PGP SIGNATURE-----
</message>
  </ns1:unsignMessage>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:PGPServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:unsignMessageResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="PGPServices">
   <unsignMessageReturn xsi:type="xsd:string">-----BEGIN PGP MESSAGE-----
Version: Cryptix OpenPGP 0.20030205

hQEOA7zq9S7fBtfhEAP/fNn/j7NXinjlptVaWlusyi5sDPYcQHnMn4+68977qwQY
K/+i9SZ6MfMdyckEtLmIyD7VbDpmKF4Q8Iy3rN7+xuL0XqBI7tKepJwyePAW+RTG
fj1AfGRwS4Hg/lwGKRRC6dk5fK3w/M2w/yQz3m3QAy4XUD90/ekit3vW+mGITIQD
/3bUHIOFSZPyz7TmFaHRinA85Oy4C/mjL4PhnJPk4p/mtNKMLBTxNjnqhXj4iPMs
ExlnUAJul53Km7+a1l9i/cKM7HzvPInPqkjuBrTXhndGpneCH1sxbckba0Iiq1Yn
ilp40gGLPZCxs8LIHFvAmSS5RmPgFP2YYFgGXt3xzhTfpB4zWPHevxXKRkOeDdqX
GKZwqqp/fdiIgzttKkTP4bQ=
=Wzrv
-----END PGP MESSAGE-----
</unsignMessageReturn>
  </ns1:unsignMessageResponse>
 </soapenv:Body>

 


Related Docs:  

H-Sphere XML API Reference



© Copyright 1998-2006. Positive Software Corporation.
All rights reserved.