somewhat gratutious reformatting by eclipse
[captive-validator.git] / src / com / verisign / tat / dnssec / SignUtils.java
index eb2cfdd..36a218d 100644 (file)
@@ -46,25 +46,24 @@ import java.util.Comparator;
 import java.util.Date;
 import java.util.Iterator;
 
-
 /**
  * This class contains a bunch of utility methods that are generally useful in
  * signing and verifying rrsets.
  */
 public class SignUtils {
     // private static final int DSA_SIGNATURE_LENGTH = 20;
-    private static final int ASN1_INT      = 0x02;
-    private static final int ASN1_SEQ      = 0x30;
-    public static final int  RR_NORMAL     = 0;
-    public static final int  RR_DELEGATION = 1;
-    public static final int  RR_GLUE       = 2;
-    public static final int  RR_INVALID    = 3;
-    private static Logger    log           = Logger.getLogger(SignUtils.class);
+    private static final int ASN1_INT = 0x02;
+    private static final int ASN1_SEQ = 0x30;
+    public static final int RR_NORMAL = 0;
+    public static final int RR_DELEGATION = 1;
+    public static final int RR_GLUE = 2;
+    public static final int RR_INVALID = 3;
+    private static Logger log = Logger.getLogger(SignUtils.class);
 
     /**
      * Generate from some basic information a prototype SIG RR containing
      * everything but the actual signature itself.
-     *
+     * 
      * @param rrset
      *            the RRset being signed.
      * @param signer
@@ -82,16 +81,16 @@ public class SignUtils {
      * @return a prototype signature based on the RRset and key information.
      */
     public static RRSIGRecord generatePreRRSIG(RRset rrset, Name signer,
-        int alg, int keyid, Date start, Date expire, long sig_ttl) {
+            int alg, int keyid, Date start, Date expire, long sig_ttl) {
         return new RRSIGRecord(rrset.getName(), rrset.getDClass(), sig_ttl,
-            rrset.getType(), alg, rrset.getTTL(), expire, start, keyid, signer,
-            null);
+                rrset.getType(), alg, rrset.getTTL(), expire, start, keyid,
+                signer, null);
     }
 
     /**
      * Generate from some basic information a prototype SIG RR containing
      * everything but the actual signature itself.
-     *
+     * 
      * @param rrset
      *            the RRset being signed.
      * @param key
@@ -106,15 +105,15 @@ public class SignUtils {
      * @return a prototype signature based on the RRset and key information.
      */
     public static RRSIGRecord generatePreRRSIG(RRset rrset, DNSKEYRecord key,
-        Date start, Date expire, long sig_ttl) {
-        return generatePreRRSIG(rrset, key.getName(), key.getAlgorithm(),
-            key.getFootprint(), start, expire, sig_ttl);
+            Date start, Date expire, long sig_ttl) {
+        return generatePreRRSIG(rrset, key.getName(), key.getAlgorithm(), key
+                .getFootprint(), start, expire, sig_ttl);
     }
 
     /**
      * Generate from some basic information a prototype SIG RR containing
      * everything but the actual signature itself.
-     *
+     * 
      * @param rec
      *            the DNS record being signed (forming an entire RRset).
      * @param key
@@ -128,28 +127,28 @@ public class SignUtils {
      * @return a prototype signature based on the Record and key information.
      */
     public static RRSIGRecord generatePreRRSIG(Record rec, DNSKEYRecord key,
-        Date start, Date expire, long sig_ttl) {
-        return new RRSIGRecord(rec.getName(), rec.getDClass(), sig_ttl,
-            rec.getType(), key.getAlgorithm(), rec.getTTL(), expire, start,
-            key.getFootprint(), key.getName(), null);
+            Date start, Date expire, long sig_ttl) {
+        return new RRSIGRecord(rec.getName(), rec.getDClass(), sig_ttl, rec
+                .getType(), key.getAlgorithm(), rec.getTTL(), expire, start,
+                key.getFootprint(), key.getName(), null);
     }
 
     /**
      * Generate the binary image of the prototype SIG RR.
-     *
+     * 
      * @param presig
      *            the SIG RR prototype.
      * @return the RDATA portion of the prototype SIG record. This forms the
      *         first part of the data to be signed.
      */
-    private static byte [] generatePreSigRdata(RRSIGRecord presig) {
+    private static byte[] generatePreSigRdata(RRSIGRecord presig) {
         // Generate the binary image;
         DNSOutput image = new DNSOutput();
 
         // precalculate some things
-        int  start_time  = (int) (presig.getTimeSigned().getTime() / 1000);
-        int  expire_time = (int) (presig.getExpire().getTime() / 1000);
-        Name signer      = presig.getSigner();
+        int start_time = (int) (presig.getTimeSigned().getTime() / 1000);
+        int expire_time = (int) (presig.getExpire().getTime() / 1000);
+        Name signer = presig.getSigner();
 
         // first write out the partial SIG record (this is the SIG RDATA
         // minus the actual signature.
@@ -167,7 +166,7 @@ public class SignUtils {
 
     /**
      * Calculate the canonical wire line format of the RRset.
-     *
+     * 
      * @param rrset
      *            the RRset to convert.
      * @param ttl
@@ -180,8 +179,8 @@ public class SignUtils {
      *         part of data to be signed.
      */
     @SuppressWarnings("unchecked")
-    public static byte [] generateCanonicalRRsetData(RRset rrset, long ttl,
-        int labels) {
+    public static byte[] generateCanonicalRRsetData(RRset rrset, long ttl,
+            int labels) {
         DNSOutput image = new DNSOutput();
 
         if (ttl == 0) {
@@ -200,15 +199,15 @@ public class SignUtils {
         boolean wildcardName = false;
 
         if (n.labels() != labels) {
-            n                = n.wild(n.labels() - labels);
-            wildcardName     = true;
-            log.trace("Detected wildcard expansion: " + rrset.getName() +
-                " changed to " + n);
+            n = n.wild(n.labels() - labels);
+            wildcardName = true;
+            log.trace("Detected wildcard expansion: " + rrset.getName()
+                    + " changed to " + n);
         }
 
         // now convert the wire format records in the RRset into a
         // list of byte arrays.
-        ArrayList<byte []> canonical_rrs = new ArrayList<byte []>();
+        ArrayList<byte[]> canonical_rrs = new ArrayList<byte[]>();
 
         for (Iterator i = rrset.rrs(); i.hasNext();) {
             Record r = (Record) i.next();
@@ -218,25 +217,24 @@ public class SignUtils {
                 // or ownername.
                 // In the TTL case, this avoids changing the ttl in the
                 // response.
-                r = Record.newRecord(n, r.getType(), r.getDClass(), ttl,
-                        r.rdataToWireCanonical());
+                r = Record.newRecord(n, r.getType(), r.getDClass(), ttl, r
+                        .rdataToWireCanonical());
             }
 
-            byte [] wire_fmt = r.toWireCanonical();
+            byte[] wire_fmt = r.toWireCanonical();
             canonical_rrs.add(wire_fmt);
         }
 
         // put the records into the correct ordering.
         // Calculate the offset where the RDATA begins (we have to skip
         // past the length byte)
-        int                 offset = rrset.getName().toWireCanonical().length +
-            10;
-        ByteArrayComparator bac    = new ByteArrayComparator(offset, false);
+        int offset = rrset.getName().toWireCanonical().length + 10;
+        ByteArrayComparator bac = new ByteArrayComparator(offset, false);
 
         Collections.sort(canonical_rrs, bac);
 
-        for (Iterator<byte []> i = canonical_rrs.iterator(); i.hasNext();) {
-            byte [] wire_fmt_rec = i.next();
+        for (Iterator<byte[]> i = canonical_rrs.iterator(); i.hasNext();) {
+            byte[] wire_fmt_rec = i.next();
             image.writeByteArray(wire_fmt_rec);
         }
 
@@ -246,17 +244,17 @@ public class SignUtils {
     /**
      * Given an RRset and the prototype signature, generate the canonical data
      * that is to be signed.
-     *
+     * 
      * @param rrset
      *            the RRset to be signed.
      * @param presig
      *            a prototype SIG RR created using the same RRset.
      * @return a block of data ready to be signed.
      */
-    public static byte [] generateSigData(RRset rrset, RRSIGRecord presig)
-        throws IOException {
-        byte [] rrset_data = generateCanonicalRRsetData(rrset,
-                presig.getOrigTTL(), presig.getLabels());
+    public static byte[] generateSigData(RRset rrset, RRSIGRecord presig)
+            throws IOException {
+        byte[] rrset_data = generateCanonicalRRsetData(rrset, presig
+                .getOrigTTL(), presig.getLabels());
 
         return generateSigData(rrset_data, presig);
     }
@@ -264,7 +262,7 @@ public class SignUtils {
     /**
      * Given an RRset and the prototype signature, generate the canonical data
      * that is to be signed.
-     *
+     * 
      * @param rrset_data
      *            the RRset converted into canonical wire line format (as per
      *            the canonicalization rules in RFC 2535).
@@ -273,12 +271,12 @@ public class SignUtils {
      *            <code>rrset_data</code>.
      * @return a block of data ready to be signed.
      */
-    public static byte [] generateSigData(byte [] rrset_data, RRSIGRecord presig)
-        throws IOException {
-        byte []               sig_rdata = generatePreSigRdata(presig);
+    public static byte[] generateSigData(byte[] rrset_data, RRSIGRecord presig)
+            throws IOException {
+        byte[] sig_rdata = generatePreSigRdata(presig);
 
-        ByteArrayOutputStream image     = new ByteArrayOutputStream(sig_rdata.length +
-                rrset_data.length);
+        ByteArrayOutputStream image = new ByteArrayOutputStream(
+                sig_rdata.length + rrset_data.length);
 
         image.write(sig_rdata);
         image.write(rrset_data);
@@ -289,33 +287,33 @@ public class SignUtils {
     /**
      * Given the actual signature and the prototype signature, combine them and
      * return the fully formed RRSIGRecord.
-     *
+     * 
      * @param signature
      *            the cryptographic signature, in DNSSEC format.
      * @param presig
      *            the prototype RRSIG RR to add the signature to.
      * @return the fully formed RRSIG RR.
      */
-    public static RRSIGRecord generateRRSIG(byte [] signature,
-        RRSIGRecord presig) {
-        return new RRSIGRecord(presig.getName(), presig.getDClass(),
-            presig.getTTL(), presig.getTypeCovered(), presig.getAlgorithm(),
-            presig.getOrigTTL(), presig.getExpire(), presig.getTimeSigned(),
-            presig.getFootprint(), presig.getSigner(), signature);
+    public static RRSIGRecord generateRRSIG(byte[] signature, RRSIGRecord presig) {
+        return new RRSIGRecord(presig.getName(), presig.getDClass(), presig
+                .getTTL(), presig.getTypeCovered(), presig.getAlgorithm(),
+                presig.getOrigTTL(), presig.getExpire(),
+                presig.getTimeSigned(), presig.getFootprint(), presig
+                        .getSigner(), signature);
     }
 
     /**
      * Converts from a RFC 2536 formatted DSA signature to a JCE (ASN.1)
      * formatted signature.
-     *
+     * 
      * <p>
      * ASN.1 format = ASN1_SEQ . seq_length . ASN1_INT . Rlength . R . ANS1_INT
      * . Slength . S
      * </p>
-     *
+     * 
      * The integers R and S may have a leading null byte to force the integer
      * positive.
-     *
+     * 
      * @param signature
      *            the RFC 2536 formatted DSA signature.
      * @return The ASN.1 formatted DSA signature.
@@ -323,11 +321,11 @@ public class SignUtils {
      *             if there was something wrong with the RFC 2536 formatted
      *             signature.
      */
-    public static byte [] convertDSASignature(byte [] signature)
-        throws SignatureException {
+    public static byte[] convertDSASignature(byte[] signature)
+            throws SignatureException {
         if (signature.length != 41) {
             throw new SignatureException(
-                "RFC 2536 signature not expected length.");
+                    "RFC 2536 signature not expected length.");
         }
 
         byte r_pad = 0;
@@ -345,15 +343,15 @@ public class SignUtils {
         // ASN.1 length = R length + S length + (2 + 2 + 2), where each 2
         // is for a ASN.1 type-length byte pair of which there are three
         // (SEQ, INT, INT).
-        byte    sig_length = (byte) (40 + r_pad + s_pad + 6);
+        byte sig_length = (byte) (40 + r_pad + s_pad + 6);
 
-        byte [] sig        = new byte[sig_length];
-        byte    pos        = 0;
+        byte[] sig = new byte[sig_length];
+        byte pos = 0;
 
-        sig[pos++]         = ASN1_SEQ;
-        sig[pos++]         = (byte) (sig_length - 2); // all but the SEQ type+length.
-        sig[pos++]         = ASN1_INT;
-        sig[pos++]         = (byte) (20 + r_pad);
+        sig[pos++] = ASN1_SEQ;
+        sig[pos++] = (byte) (sig_length - 2); // all but the SEQ type+length.
+        sig[pos++] = ASN1_INT;
+        sig[pos++] = (byte) (20 + r_pad);
 
         // copy the value of R, leaving a null byte if necessary
         if (r_pad == 1) {
@@ -363,8 +361,8 @@ public class SignUtils {
         System.arraycopy(signature, 1, sig, pos, 20);
         pos += 20;
 
-        sig[pos++]     = ASN1_INT;
-        sig[pos++]     = (byte) (20 + s_pad);
+        sig[pos++] = ASN1_INT;
+        sig[pos++] = (byte) (20 + s_pad);
 
         // copy the value of S, leaving a null byte if necessary
         if (s_pad == 1) {
@@ -379,15 +377,15 @@ public class SignUtils {
     /**
      * Converts from a JCE (ASN.1) formatted DSA signature to a RFC 2536
      * compliant signature.
-     *
+     * 
      * <p>
      * rfc2536 format = T . R . S
      * </p>
-     *
+     * 
      * where T is a number between 0 and 8, which is based on the DSA key
      * length, and R & S are formatted to be exactly 20 bytes each (no leading
      * null bytes).
-     *
+     * 
      * @param params
      *            the DSA parameters associated with the DSA key used to
      *            generate the signature.
@@ -397,25 +395,25 @@ public class SignUtils {
      * @throws SignatureException
      *             if something is wrong with the ASN.1 format.
      */
-    public static byte [] convertDSASignature(DSAParams params,
-        byte [] signature) throws SignatureException {
+    public static byte[] convertDSASignature(DSAParams params, byte[] signature)
+            throws SignatureException {
         if ((signature[0] != ASN1_SEQ) || (signature[2] != ASN1_INT)) {
             throw new SignatureException(
-                "Invalid ASN.1 signature format: expected SEQ, INT");
+                    "Invalid ASN.1 signature format: expected SEQ, INT");
         }
 
         byte r_pad = (byte) (signature[3] - 20);
 
         if (signature[24 + r_pad] != ASN1_INT) {
             throw new SignatureException(
-                "Invalid ASN.1 signature format: expected SEQ, INT, INT");
+                    "Invalid ASN.1 signature format: expected SEQ, INT, INT");
         }
 
         log.trace("(start) ASN.1 DSA Sig:\n" + base64.toString(signature));
 
-        byte    s_pad = (byte) (signature[25 + r_pad] - 20);
+        byte s_pad = (byte) (signature[25 + r_pad] - 20);
 
-        byte [] sig   = new byte[41]; // all rfc2536 signatures are 41 bytes.
+        byte[] sig = new byte[41]; // all rfc2536 signatures are 41 bytes.
 
         // Calculate T:
         sig[0] = (byte) ((params.getP().bitLength() - 512) / 64);
@@ -437,13 +435,15 @@ public class SignUtils {
             // S is shorter than 20 bytes, so right justify the number
             // (s_pad is negative here).
             Arrays.fill(sig, 21, 21 - s_pad, (byte) 0);
-            System.arraycopy(signature, 26 + r_pad, sig, 21 - s_pad, 20 +
-                s_pad);
+            System
+                    .arraycopy(signature, 26 + r_pad, sig, 21 - s_pad,
+                            20 + s_pad);
         }
 
         if ((r_pad < 0) || (s_pad < 0)) {
-            log.trace("(finish ***) RFC 2536 DSA Sig:\n" +
-                base64.toString(sig));
+            log
+                    .trace("(finish ***) RFC 2536 DSA Sig:\n"
+                            + base64.toString(sig));
         } else {
             log.trace("(finish) RFC 2536 DSA Sig:\n" + base64.toString(sig));
         }
@@ -456,24 +456,26 @@ public class SignUtils {
      * useful for comparing RDATA portions of DNS records in doing DNSSEC
      * canonical ordering.
      */
-    public static class ByteArrayComparator implements Comparator<byte []> {
-        private int     mOffset = 0;
-        private boolean mDebug  = false;
+    public static class ByteArrayComparator implements Comparator<byte[]> {
+        private int mOffset = 0;
+        private boolean mDebug = false;
 
-        public ByteArrayComparator() {}
+        public ByteArrayComparator() {
+        }
 
         public ByteArrayComparator(int offset, boolean debug) {
-            mOffset     = offset;
-            mDebug      = debug;
+            mOffset = offset;
+            mDebug = debug;
         }
 
-        public int compare(byte [] b1, byte [] b2) throws ClassCastException {
+        public int compare(byte[] b1, byte[] b2) throws ClassCastException {
             for (int i = mOffset; (i < b1.length) && (i < b2.length); i++) {
                 if (b1[i] != b2[i]) {
                     if (mDebug) {
-                        System.out.println("offset " + i +
-                            " differs (this is " + (i - mOffset) +
-                            " bytes in from our offset.)");
+                        System.out
+                                .println("offset " + i + " differs (this is "
+                                        + (i - mOffset)
+                                        + " bytes in from our offset.)");
                     }
 
                     return (b1[i] & 0xFF) - (b2[i] & 0xFF);