[interchange-cvs] interchange - ramoore modified code/Filter/decrypt.filter

[interchange-core@icdevgroup.org]

User:      ramoore
Date:      2003-04-05 06:03:00 GMT
Modified:  code/Filter decrypt.filter
Log:
Added brief docs in file and turned off logging

Revision  Changes    Path
1.2       +37 -3     interchange/code/Filter/decrypt.filter


rev 1.2, prev_rev 1.1
Index: decrypt.filter
===================================================================
RCS file: /var/cvs/interchange/code/Filter/decrypt.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- decrypt.filter	5 Apr 2003 05:45:10 -0000	1.1
+++ decrypt.filter	5 Apr 2003 06:03:00 -0000	1.2
@@ -1,4 +1,38 @@
 CodeDef decrypt Filter
+CodeDef decrypt Documentation <<EOF
+
+=pod
+
+=head1 decrypt
+
+       Decrypts the value against the standard GPG/PGP key
+           using the standard EncryptProgram.
+
+                  [filter op=decrypt] String [/filter]
+
+       You can decrypt against other keys by passing the ID as an argument:
+
+                  [filter op=decrypt.23883AEE]
+                        String, to decrypt against different key.
+                  [/filter]
+
+       You can even specify a different EncryptProgram decrypt by passing an ID 
+            and the program to use as arguments:
+
+                  [filter op=decrypt.23883AEE.pgp]
+                        String, to decrypt against different key using pgp 
+                        rather than the default
+                  [/filter]
+
+
+	Perl call:
+		my $cleartext = $Tag->filter('decrypt.672235FF', $ciphertext);
+
+	where  672235FF should be replace with your PGP_KEY value
+
+=cut
+EOF
+
 CodeDef decrypt Routine <<EOR
 sub {
 	my ($body, $tag, $key, $cmd) = @_;
@@ -31,7 +65,7 @@
                 $cmd =~ s/:~PERCENT~:/%/g;
         }
 
-#::logDebug("filter decrypt after key=$key cmd=$cmd");
+#::logDebug("decrypt filter after key=$key cmd=$cmd");
 
 	my $fpre = $Vend::Cfg->{ScratchDir} . "/pgp.$Vend::Session->{id}.$$";
 
@@ -53,9 +87,9 @@
                         $status = $status >> 8;
                         $! = $status;
                 }
-                logError("PGP failed with error level %s, status %s: $!", $?, $status);
+                logError("decrypt failed with error level %s, status %s: $!", $?, $status);
                 if($status) {
-                        logError("PGP hard failure, command that failed: %s", $cmd);
+                        logError("decrypt hard failure, command that failed: %s", $cmd);
                         return;
                 } 
         }