Skip to content

Improve PGP encrypt/decrypt file JavaDoc #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Improve PGP encrypt/decrypt file JavaDoc #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
64f8047
PGP JavaDoc improvements, focused on classes used in PBE file encrypt…
timw Jun 15, 2014
6b32e34
Replace inline array copy with Arrays.clone
timw Jun 15, 2014
a7a1bae
Reduce File based open override in PGPLiteralDataGenerator to call to…
timw Jun 15, 2014
9c6b685
Remove redundant method override.
timw Jun 15, 2014
70cabf6
Use PGPLiteralData File open variant directly.
timw Jun 15, 2014
2902637
Some TODOs about implementation loose ends.
timw Jun 15, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 56 additions & 44 deletions pg/src/main/java/org/bouncycastle/bcpg/ArmoredOutputStream.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import java.util.Hashtable;

/**
* Basic output stream.
* Output stream that writes data in ASCII Armored format.
*/
public class ArmoredOutputStream
extends OutputStream
Expand Down Expand Up @@ -84,7 +84,7 @@ private void encode(
boolean start = true;
boolean clearText = false;
boolean newLine = false;

String nl = System.getProperty("line.separator");

String type;
Expand All @@ -94,41 +94,53 @@ private void encode(
String footerTail = "-----";

String version = "BCPG v@RELEASE_NAME@";

Hashtable headers = new Hashtable();


/**
* Constructs an armored output stream with {@link #resetHeaders() default headers}.
*
* @param out the OutputStream to wrap.
*/
public ArmoredOutputStream(
OutputStream out)
{
this.out = out;

if (nl == null)
{
nl = "\r\n";
}

resetHeaders();
}


/**
* Constructs an armored output stream with default and custom headers.
*
* @param out the OutputStream to wrap.
* @param headers additional headers that add to or override the {@link #resetHeaders() default
* headers}.
*/
public ArmoredOutputStream(
OutputStream out,
Hashtable headers)
{
this(out);

Enumeration e = headers.keys();

while (e.hasMoreElements())
{
Object key = e.nextElement();

this.headers.put(key, headers.get(key));
}
}

/**
* Set an additional header entry.
*
*
* @param name the name of the header entry.
* @param value the value of the header entry.
*/
Expand All @@ -138,7 +150,7 @@ public void setHeader(
{
this.headers.put(name, value);
}

/**
* Reset the headers to only contain a Version string.
*/
Expand All @@ -147,17 +159,17 @@ public void resetHeaders()
headers.clear();
headers.put("Version", version);
}

/**
* Start a clear text signed message.
* @param hashAlgorithm
*/
public void beginClearText(
int hashAlgorithm)
int hashAlgorithm)
throws IOException
{
String hash;

switch (hashAlgorithm)
{
case HashAlgorithmTags.SHA1:
Expand All @@ -184,43 +196,43 @@ public void beginClearText(
default:
throw new IOException("unknown hash algorithm tag in beginClearText: " + hashAlgorithm);
}

String armorHdr = "-----BEGIN PGP SIGNED MESSAGE-----" + nl;
String hdrs = "Hash: " + hash + nl + nl;

for (int i = 0; i != armorHdr.length(); i++)
{
out.write(armorHdr.charAt(i));
}

for (int i = 0; i != hdrs.length(); i++)
{
out.write(hdrs.charAt(i));
}

clearText = true;
newLine = true;
lastb = 0;
}

public void endClearText()
{
clearText = false;
}

private void writeHeaderEntry(
String name,
String value)
String value)
throws IOException
{
for (int i = 0; i != name.length(); i++)
{
out.write(name.charAt(i));
}

out.write(':');
out.write(' ');

for (int i = 0; i != value.length(); i++)
{
out.write(value.charAt(i));
Expand All @@ -231,7 +243,7 @@ private void writeHeaderEntry(
out.write(nl.charAt(i));
}
}

public void write(
int b)
throws IOException
Expand Down Expand Up @@ -259,12 +271,12 @@ public void write(
lastb = b;
return;
}

if (start)
{
boolean newPacket = (b & 0x40) != 0;
int tag = 0;

if (newPacket)
{
tag = b & 0x3f;
Expand All @@ -288,7 +300,7 @@ public void write(
default:
type = "MESSAGE";
}

for (int i = 0; i != headerStart.length(); i++)
{
out.write(headerStart.charAt(i));
Expand All @@ -308,20 +320,20 @@ public void write(
{
out.write(nl.charAt(i));
}

writeHeaderEntry("Version", (String)headers.get("Version"));

Enumeration e = headers.keys();
while (e.hasMoreElements())
{
String key = (String)e.nextElement();

if (!key.equals("Version"))
{
writeHeaderEntry(key, (String)headers.get(key));
}
}

for (int i = 0; i != nl.length(); i++)
{
out.write(nl.charAt(i));
Expand All @@ -346,12 +358,12 @@ public void write(
crc.update(b);
buf[bufPtr++] = b & 0xff;
}

public void flush()
throws IOException
{
}

/**
* <b>Note</b>: close does nor close the underlying stream. So it is possible to write
* multiple objects using armoring to a single stream.
Expand All @@ -362,48 +374,48 @@ public void close()
if (type != null)
{
encode(out, buf, bufPtr);

for (int i = 0; i != nl.length(); i++)
{
out.write(nl.charAt(i));
}
out.write('=');

int crcV = crc.getValue();

buf[0] = ((crcV >> 16) & 0xff);
buf[1] = ((crcV >> 8) & 0xff);
buf[2] = (crcV & 0xff);

encode(out, buf, 3);

for (int i = 0; i != nl.length(); i++)
{
out.write(nl.charAt(i));
}

for (int i = 0; i != footerStart.length(); i++)
{
out.write(footerStart.charAt(i));
}

for (int i = 0; i != type.length(); i++)
{
out.write(type.charAt(i));
}

for (int i = 0; i != footerTail.length(); i++)
{
out.write(footerTail.charAt(i));
}

for (int i = 0; i != nl.length(); i++)
{
out.write(nl.charAt(i));
}

out.flush();

type = null;
start = true;
}
Expand Down
Loading