Commons OpenPGP

- - -

+ +

- - - - - - - -

- Last Published: 17 May 2008 - | Version: 1.0-SNAPSHOT + +

+ Last Published: 11 August 2013 + | Version: 1.0-SNAPSHOT

ApacheCon +

ApacheCon | - Apache + Apache | - Commons + Commons | - Sandbox + Sandbox | - Bouncy Castle - - - - - - - - -

+ Bouncy Castle + + +

- - - - - - - - -

- Overview -
- Usage -
- Signer Ant Task -

Commons OpenPGP

+ Overview +
+ Usage +

Development

- Mailing Lists -
- Issue Tracking -
- Team -
- Source Repository -
- Javadoc (latest) -

Ant Tasks

+ Signer +
+ Verifier +

Project Documentation

- Project Information -
- Project Reports -
- - Cobertura Test Coverage -
- - CPD Report -
- - JavaDocs -
- - JDepend -
- - Maven Surefire Report -
- - PMD Report -
- - RAT Report -
- - Source Xref -
- - Tag List -
- - Test JavaDocs -
- - Test Source Xref -

+ +

Generated Reports

This document provides an overview of the various reports that are automatically generated by Maven - Each report is briefly described below.

Overview

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Document	Description
Cobertura Test Coverage -	Cobertura Test Coverage Report.
CPD Report -	Duplicate code detection.
JavaDocs -	JavaDoc API documentation.
JDepend -	JDepend traverses Java class file directories and generates design quality metrics for each Java package. JDepend allows you to automatically measure the quality of a design in terms of its extensibility, reusability, and maintainability to manage package dependencies effectively.
Maven Surefire Report -	Report on the test results of the project.
PMD Report -	Verification of coding rules.
RAT Report -	Report on compliance to license related source code policies
Source Xref -	HTML based, cross-reference version of Java source code.
Tag List -	Report on various tags found in the code.
Test JavaDocs -	Test JavaDoc API documentation.
Test Source Xref -	HTML based, cross-reference version of Java test source code.

- +

Generated Reports

This document provides an overview of the various reports that are automatically generated by Maven . Each report is briefly described below.

Overview

Document	Description
JIRA Report	Report on Issues from the JIRA Issue Tracking System.
JavaDocs	JavaDoc API documentation.
Test JavaDocs	Test JavaDoc API documentation.
Source Xref	HTML based, cross-reference version of Java source code.
Test Source X ref	HTML based, cross-reference version of Java test source code.
Surefire Report	Report on the test results of the project.
RAT Report	Report on compliance to license related source code policies
JDepend	JDepend traverses Java class file directories and generates design quality metrics for each Java package. JDepend allows you to automatically measure the quality of a design in terms of its extensibility, reusability, and maintainability to manage package dependencies effectively.
PMD Report	Verification of coding rules.
CPD Report	Duplicate code detection.
Cobertura Test Coverage	Cobert ura Test Coverage Report.
Tag List	Report on various tags found in the code.

+ +

Apache Commons, Apache Commons OpenPGP (Sandbox), Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation. + All other marks mentioned may be trademarks or registered trademarks of their respective owners.

- + \ No newline at end of file Modified: websites/production/commons/content/sandbox/commons-openpgp/project-summary.html ============================================================================== --- websites/production/commons/content/sandbox/commons-openpgp/project-summary.html (original) +++ websites/production/commons/content/sandbox/commons-openpgp/project-summary.html Sat Aug 10 22:25:17 2013 @@ -1,17 +1,9 @@ - - - - - - - - - - - - + + + + Commons OpenPGP - Project Summary - - + + + + + + +

- - -

+ +

- - - - - - - -

- Last Published: 17 May 2008 - | Version: 1.0-SNAPSHOT + +

+ Last Published: 11 August 2013 + | Version: 1.0-SNAPSHOT

ApacheCon +

ApacheCon | - Apache + Apache | - Commons + Commons | - Sandbox + Sandbox | - Bouncy Castle - - - - - - - - -

+ Bouncy Castle + + +

- - - - - - - - -

Commons OpenPGP

- Overview -
- Usage -
- Signer Ant Task -

Commons OpenPGP

+ Overview +
+ Usage +

Development

- Mailing Lists -
- Issue Tracking -
- Team -
- Source Repository -
- Javadoc (latest) -

Ant Tasks

+ Signer +
+ Verifier +

Project Documentation

- Project Information +
Development
- - Continuous Integration -
- - Dependencies -
- - Mailing Lists -
- - Project License -
- - Project Summary -
- - Project Team -
- - Source Repository -
- + Mailing Lists +
- + Issue Tracking +
- + Team +
- + Source Repository +
- + Javadoc (latest) +
+
Project Documentation
+
- + Project Information +
  - + About +
  - + Project Team +
  - + Continuous Integration +
  - + Issue Tracking +
  - + Source Repository +
  - + Distribution Management +
  - + Project Summary +
  - + Mailing Lists +
  - + Dependencies +
- - Project Reports -
- + Project Reports +
-
Commons
-
- - Home -
- - Components -
- - Sandbox -
- - Dormant -
- - Volunteering -
- - Contributing Patches -
- - Building Components -
- - Releasing Components -
- - Wiki -

+ +

Project Summary

Project Information

- - - - - - - - - - - - -

Field	Value
Name	Commons OpenPGP (Sandbox)
Description	The Apache Software Foundation provides support for the Apache community of open-source software projects. - The Apache projects are characterized by a collaborative, consensus based development process, an open and - pragmatic software license, and a desire to create high quality software that leads the way in its field. - We consider ourselves not simply a group of projects sharing a server, but rather a community of developers - and users.
Homepage	http://commons.apache.org/sandbox/openpgp/ -

Project Organization

- - - - - - - - - -

Field	Value
Name	The Apache Software Foundation
URL	http://www.apache.org/ -

Build Information

- - - - - - - - - - - - - - - -

Field	Value
GroupId	org.apache.commons
ArtifactId	commons-openpgp
Version	1.0-SNAPSHOT
Type	jar

- +

Project Summary

Project Information

Field	Value
Name	Commons OpenPGP (Sandbox)
Description	The Apache Commons Parent Pom provides common settings for all Apache Commons components.
Homepage	http://commons.apache.org/sandbox/openpgp/

Project Organization

http://www.apache.org/

Field	Value
Name	The Apache Software Foundation
URL

Build Information

Field	Value
GroupId	org.apache.commons
ArtifactId	commons-openpgp
Version	1.0-SNAPSHOT
Type	jar
JDK Rev	1.5

+ +

- + \ No newline at end of file Modified: websites/production/commons/content/sandbox/commons-openpgp/rat-report.html ============================================================================== Binary files - no diff available. Modified: websites/production/commons/content/sandbox/commons-openpgp/signer.html ============================================================================== --- websites/production/commons/content/sandbox/commons-openpgp/signer.html (original) +++ websites/production/commons/content/sandbox/commons-openpgp/signer.html Sat Aug 10 22:25:17 2013 @@ -1,17 +1,9 @@ - - - - - - - - - - - - + + + + Commons OpenPGP - Signer Ant Task - - - + + + + + + + +

- - -

+ +

- - - - - - - -

- Last Published: 17 May 2008 - | Version: 1.0-SNAPSHOT + +

+ Last Published: 11 August 2013 + | Version: 1.0-SNAPSHOT

ApacheCon +

ApacheCon | - Apache + Apache | - Commons + Commons | - Sandbox + Sandbox | - Bouncy Castle - - - - - - - - -

+ Bouncy Castle + + +

- - - - - - - - -

Commons OpenPGP

- Overview -
- Usage -
- Signer Ant Task -

Commons OpenPGP

+ Overview +
+ Usage +

Development

- Mailing Lists -
- Issue Tracking -
- Team -
- Source Repository -
- Javadoc (latest) -

Ant Tasks

+ Signer +
+ Verifier +

Project Documentation

- Project Information -
- Project Reports -

Development

Commons

- Home -
- Components -
- Sandbox -
- Dormant -
- Volunteering -
- Contributing Patches -
- Building Components -
- Releasing Components -
- Wiki -

Project Documentation

+ Project Information +
+ Project Reports +

ASF

- Sponsorship -
- Thanks -

Commons

+ Home +
+ License +
+ Components +
+ Sandbox +
+ Dormant +

General Information

ASF

+ +

Signer Ant Task

This task will be packaged in the commons-openpgp.jar. It will use the bouncy castle jars at runtime. It has been tested with bcpg-jdk12-134.jar and bcprov-jdk12-134.jar. The generated signatures can be verified with gpg.

signer - can sign one or several files at once.

`attributes` -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Attribute	Description	Required
`secring` -	Secret key ring file.	Yes
`pubring` -	Public key ring file.	Yes
`password` -	Password of the secret key ring.	Yes
`keyid` -	Id of the key used to sign.	Yes
`asciiarmor` -	Boolean, defaults to true.	No
`artefact` -	The file that you want to sign.	No, if fileset nested element present.

The task must also take either one or several nested fileset - element, or an artefact - attribute.

`fileset` - nested element

The task can take one or several fileset nested elements. See the ant manual - for an explanation. If you want to sign just one file, the artefact - attribute can be used instead.

`mapper` - nested element

The task may take a mapper - nested element. This nested element tells the task how the signature files should be called. If you do not supply this element, the signature files will be located in the same directory as the files that you sign. An ending of .asc - will be appended to the file name for ascii armored output (the default). If you set asciiarmor - to false, the ending will be .sig -

example

<project name="test1" xmlns:openpgp="antlib:org.apache.commons.openpgp.ant">
+        Signer Ant Task
This task will be packaged in the commons-openpgp.jar. It will use the BouncyCastle JARs at runtime. It has been tested with bcpg-jdk12-134.jar and bcprov-jdk12-134.jar. The generated signatures can be verified with GPG.
The signer task can sign one or more files at once.
Attributes
Attribute Description Required
secring Secret key ring file. Yes
pubring Public key ring file. Yes
password Password of the secret key ring. Yes
keyid Id of the key used to sign. Yes
asciiarmor Whether to use ASCII armor. Boolean, defaults to true. No
artefact The file that you want to sign. No, if a fileset nested element is present.
The task must also take either one or more nested fileset elements, or an artefact attribute.
fileset nested element
The task can take one or more fileset nested elements. See the  Ant manual for an explanation. If you want to sign just one file, the artefact attribute can be used instead.
 mapper nested element
The task may take a  mapper nested element. This nested element tells the task how the signature files should be named. If you do not supply this element, the signature files will be located in the same directory as the files that you sign. An ending of .asc will be appended to the file name for ASCII armored output (the default). If you set asciiarmor to false, the ending will be .sig
Example
<project name="test1" xmlns:openpgp="antlib:org.apache.commons.openpgp.ant">
+  <property environment="env"/>
   <taskdef resource="org/apache/commons/openpgp/ant/antlib.xml" uri="antlib:org.apache.commons.openpgp.ant"/>
   <openpgp:signer secring="${env.USERPROFILE}\Application Data\gnupg\secring.gpg"
     pubring="${env.USERPROFILE}\Application Data\gnupg\pubring.gpg"
     password="secret" keyid="12345678"
     artefact="target\commons-openpgp-1.0-SNAPSHOT.jar"
     asciiarmor="true"/>
-</project>

-
-
-
-
+</project>
+

Attribute	Description	Required
`secring`	Secret key ring file.	Yes
`pubring`	Public key ring file.	Yes
`password`	Password of the secret key ring.	Yes
`keyid`	Id of the key used to sign.	Yes
`asciiarmor`	Whether to use ASCII armor. Boolean, defaults to `true`.	No
`artefact`	The file that you want to sign.	No, if a fileset nested element is present.

+ +

- + \ No newline at end of file

Commons OpenPGP

Commons OpenPGP

Development

Ant Tasks

Project Documentation

Development

Project Documentation

Commons

Commons

ASF

General Information

ASF

Generated Reports

Overview

Generated Reports

Overview

Commons OpenPGP

Commons OpenPGP

Development

Ant Tasks

Project Documentation

Development

Project Documentation

Commons

Commons

ASF

General Information

ASF

Project Summary

Project Information

Project Organization

Build Information

Project Summary

Project Information

Project Organization

Build Information

Commons OpenPGP

Commons OpenPGP

Development

Ant Tasks

Project Documentation

Development

Commons

Project Documentation

ASF

Commons

General Information

ASF

Signer Ant Task

attributes -

fileset - nested element

mapper - nested element

example

Signer Ant Task

Attributes

fileset nested element

mapper nested element

Example

`attributes` -

`fileset` - nested element

`mapper` - nested element

`fileset` nested element

`mapper` nested element