PGP Package Service

Implementing the PGP Package Service

Configuring the PGP Package Service

To configure the PGP Package service, specify settings specify the settings for the fields in the GPM. These fields are described in the following table:

Parameters Passed from Service to BP

The following table contains the parameters that are passed from the PGP Package service to the business process:

Business Process Example - Encrypt Operation (Public Key Encryption)

This following business process uses the PGP Package service to encrypt the primary document in the document area. The profile is based on PGP107. In this example, you use the default Command Line2 adapter configuration, PGPCmdlineService, to execute the encrypt command. You want to use the working directory, remote name and port stated in the BPML. Therefore, these values override the pre-configured values in PGPCmdLineService. The public key ID, which must be in the public keyring file specified in the profile, PGP107, is used for encryption.

<process name="PGP_Encrypt ">
  <sequence name="optional">
   <operation name="One">
      <participant name="PGPPackageService"/>
      <output message="Xout">
              <assign to="." from="*"></assign>
              <assign to="profile_name">PGP107</assign>
              <assign to="compress">on</assign>
              <assign to="workingDir">/server1/tmp</assign>
              <assign to="remoteName">00.000.00.000</assign>	
              <assign to="remotePort">12345</assign>         
              <assign to="public_user">0x2343</assign> 
    </output>
     <input message="Xin">
              <assign to="." from="*"></assign>
     </input>
   </operation>
  </sequence> 
</process>

Business Process Example - Encrypt Operation (Conventional Encryption)

This following business process uses the PGP Package service to encrypt the primary document in the document area of process data. The profile is based on PGP107. In this example, you use the Command Line2 adapter configuration, MyCLA2, to execute the commands. The remote name, port, and working directory are pre-configured in the service configuration. The value of conv_keymap_name, Conv_abc_tp, which must be in the profile's conventional key map, is used for conventional encryption:

<process name="PGP_Encrypt ">
  <sequence name="optional">
   <operation name="One">
      <participant name=" PGPPackageService "/>
      <output message="Xout">
        <assign to="." from="*"></assign>
              <assign to="profile_name">PGP107</assign>
              <assign to="compress">on</assign> 
              <assign to="conv_keymap_name">Conv_abc_tp</assign> 
              <assign to="conv_cipher">CAST5</assign>
              <assign to="cmdline2svcname">MyCLA2</assign> 
    </output>
     <input message="Xin">
              <assign to="." from="*"></assign>
     </input>
   </operation>
  </sequence> 
</process>

Business Process Example - Encrypt and Sign Operation (Public Key Encryption)

The following business process uses the PGP Package service to encrypt and sign the primary document in the document area. For signing, you need to pass in the secret_keymap_name, which must be in the PGP107 profile's secret key map. The public key ID, which must be in the public keyring file specified in the profile, PGP107, is used for encryption. In this example, you choose not to compress the document before signing and encryption.

<process name="PGP_Encrypt_Sign">
  <sequence name="optional">
   <operation name="One">
      <participant name=" PGPPackageService "/>
      <output message="Xout">
        <assign to="." from="*"></assign>
              <assign to="profile_name">PGP107</assign>
              <assign to="compress">off</assign>
              <assign to="workingDir">/server1/tmp</assign>
              <assign to="remoteName">00.000.00.000</assign>	
              <assign to="remotePort">12345</assign>         
              <assign to="public_user">0x2343</assign>
              <assign to="secret_keymap_name">my_secret</assign> 
</output>
    <input message="Xin">
              <assign to="." from="*"></assign>
     </input>
   </operation>
  </sequence> 
</process>

Business Process Example - Encrypt and Sign Operation (Conventional Encryption)

The following business process uses PGP Package Service to encrypt and sign the Primary Document in the document area. For signing, the user needs to pass in the secret_keymap_name, which must be present in the PGP107 profile's Secret Key Map. The value of conv_keymap_name, Conv_abc_tp, which must be present in the Profile's Conventional Key Map, is used for conventional encryption. The user chooses not to compress the document before signing and encryption.

<process name="PGP_Encrypt_Sign">
 <sequence name="optional">
    <operation name="One">
      <participant name=" PGPPackageService "/>
      <output message="Xout">
              <assign to="profile_name">PGP107</assign>
              <assign to="compress">off</assign>
              <assign to="workingDir">/localsvr/share/tmp</assign>
              <assign to="remoteName">nn.nnn.nn.nnn</assign>               
              <assign to="remotePort">xxxxx</assign>         
              <assign to="conv_keymap_name">Conv_abc_tp</assign> 
              <assign to="conv_cipher">CAST5</assign>
              <assign to="secret_keymap_name">si_secret</assign>
              <assign to="." from="*"></assign>
     </output>
    <input message="Xin">
        <assign to="." from="*"></assign>
     </input>
   </operation>
  </sequence> 
</process>

Business Process Example - Encrypt Operation (Public Key Encryption) Using a Specific Document ID

The following business process uses the PGP Package service to encrypt a document, with the document ID columbia:1774b9b:feaea8ae12:-6ea8 in the document area.

<process name="PGP_Encrypt ">
 <sequence name="optional">
    <operation name="One"> PGPPackageService
      <participant name="PGPPackageService"/>
      <output message="Xout">
              <assign to="." from="*"></assign>
              <assign to="profile_name">PGP107</assign>
              <assign to="compress">on</assign>
              <assign to="workingDir">/server1/tmp</assign>
              <assign to="remoteName">00.000.00.000</assign>	
              <assign to="remotePort">12345</assign>   
              <assign to="public_user">0x2343</assign>
              <assign to="DocumentId">columbia:1774b9b:feaea8ae12:
                          -6ea8</assign>
    </output>
     <input message="Xin">
              <assign to="." from="*"></assign>
     </input>
   </operation>
  </sequence> 
</process>

Business Process Example - Sign Operation

The following business process uses the PGP Package service to sign the primary document in the document area.

<process name="PGP_Sign ">
  <sequence name="optional">
   <operation name="One">
      <participant name="PGPPackageService"/>
      <output message="Xout">
        <assign to="." from="*"></assign>
              <assign to="profile_name">PGP107</assign>
              <assign to="compress">on</assign>
              <assign to="workingDir">/server1/tmp</assign>
              <assign to="remoteName">00.000.00.000</assign>	
              <assign to="remotePort">12345</assign>         
              <assign to="secret_keymap_name">my_secret</assign>
    </output>
     <input message="Xin">
              <assign to="." from="*"></assign>
     </input>
   </operation>
  </sequence> 
</process>

Business Process Example - OnFault Handling

The following business process shows the onFault handling for the PGP Package service.

<process name="PGP_Sign ">
 <sequence name="optional">
    <operation name="One">
      <participant name="PGPPackageService"/>
     <output message="Xout">
			<assign to="profile_name">PGP107</assign>
			<assign to="compress">on</assign>
			<assign to="workingDir">/localsvr/share/tmp</assign>
			<assign to="remoteName">nn.nnn.nn.nnn</assign>         	
			<assign to="remotePort">12345</assign>         
			<assign to="secret_keymap_name">si_secret</assign>
			<assign to="." from="*"></assign>
     </output>
    <input message="Xin">
        <assign to="." from="*"></assign>
     </input>
   </operation>
  		<assign to="Status">The file is signed successfully</assign>
   <onFault>
      <assign to="Status">General Error Occurred</assign>
    </onFault>
   <onFault code="[PGPErrorCode] Signature Check error">
     <assign to="Status">Incorrect signature</assign>
   </onFault>
  </sequence> 
</process>

Business Process Example - PGP Partner and PGP Sponsor

The following business process uses the PGP Partner and PGP Sponsor services to encrypt and sign documents.

<process name="use_partner_sponsor">
  <operation name="PGP Package Service">
    <participant name="PGPPackageService"/>
        <output message="PGPPackageServiceTypeInputMessage">
     <assign to="pgp_partner_name">partner</assign>
     <assign to="pgp_sponsor_name">sponsor</assign>
     <assign to="profile_name">pgp</assign>
     <assign to="." from="*"></assign>
   </output>
    <input message="inmsg">
     <assign to="." from="*"></assign>
   </input>
  </operation> 
</process>

Advanced Status Messages

The following table contains exit codes from E-Business Server. The content of the Description field is displayed in the Advanced Status column, preceded by [PGPErrorCode]:

The following table contains exit codes from PGP Command Line. The content of the Description field is displayed in the Advanced Status column, preceded by [PGPErrorCode]:

The following table contains errors that result from the PGP Package service when it validates information before executing PGP commands on the remote server. The content of the status field will be displayed in the Advanced Status column: