SigUtil (I2P Anonymous Network - Java Documentation

java.lang.Object
- net.i2p.crypto.SigUtil

```
public final class SigUtil
extends Object
```
Utilities for Signing keys and Signatures

Since:

0.9.9, public since 0.9.12

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static NativeBigInteger[]`	`aSN1ToBigInteger(byte[] asn, int len)`	See above.
`static void`	`clearCaches()`
`(package private) static byte[]`	`combine(BigInteger x, BigInteger y, int len)`	Combine two BigIntegers of nominal length = len / 2
`static SigningPrivateKey`	`fromJavaKey(DSAPrivateKey pk)`
`static SigningPublicKey`	`fromJavaKey(DSAPublicKey pk)`
`static SigningPrivateKey`	`fromJavaKey(ECPrivateKey pk, SigType type)`
`static SigningPublicKey`	`fromJavaKey(ECPublicKey pk, SigType type)`
`static SigningPrivateKey`	`fromJavaKey(RSAPrivateKey pk, SigType type)`	As of 0.9.31, if pk is a RSAPrivateCrtKey, this will return a RSASigningPrivateCrtKey.
`static SigningPublicKey`	`fromJavaKey(RSAPublicKey pk, SigType type)`
`static SigningPrivateKey`	`fromJavaKey(PrivateKey pk)`	Use if SigType is unknown.
`static SigningPrivateKey`	`fromJavaKey(PrivateKey pk, SigType type)`	Use if SigType is known.
`static SigningPublicKey`	`fromJavaKey(PublicKey pk)`	Use if SigType is unknown.
`static SigningPublicKey`	`fromJavaKey(PublicKey pk, SigType type)`	Use if SigType is known.
`static SigningPrivateKey`	`fromJavaKey(EdDSAPrivateKey pk, SigType type)`
`static SigningPublicKey`	`fromJavaKey(EdDSAPublicKey pk, SigType type)`
`static Signature`	`fromJavaSig(byte[] asn, SigType type)`
`static PrivateKey`	`importJavaPrivateKey(File file, SigType type)`
`static PublicKey`	`importJavaPublicKey(File file, SigType type)`
`static int`	`intToASN1(byte[] d, int idx, int val)`	Output an length or integer value in ASN.1 Does NOT output the tag e.g.
`static byte[]`	`rectify(BigInteger bi, int len)`
`static byte[]`	`sigBytesToASN1(BigInteger r, BigInteger s)`	http://download.oracle.com/javase/1.5.0/docs/guide/security/CryptoSpec.html
`static DSAPrivateKey`	`toJavaDSAKey(SigningPrivateKey pk)`
`static DSAPublicKey`	`toJavaDSAKey(SigningPublicKey pk)`
`static ECPrivateKey`	`toJavaECKey(SigningPrivateKey pk)`
`static ECPublicKey`	`toJavaECKey(SigningPublicKey pk)`
`static EdDSAPrivateKey`	`toJavaEdDSAKey(SigningPrivateKey pk)`
`static EdDSAPublicKey`	`toJavaEdDSAKey(SigningPublicKey pk)`
`static PrivateKey`	`toJavaKey(SigningPrivateKey pk)`
`static PublicKey`	`toJavaKey(SigningPublicKey pk)`
`static RSAPrivateKey`	`toJavaRSAKey(SigningPrivateKey pk)`	As of 0.9.31, if pk is a RSASigningPrivateCrtKey, this will return a RSAPrivateCrtKey.
`static RSAPublicKey`	`toJavaRSAKey(SigningPublicKey pk)`	Deprecated. unused
`static byte[]`	`toJavaSig(Signature sig)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

toJavaKey

public static PublicKey toJavaKey(SigningPublicKey pk)
                           throws GeneralSecurityException

Returns:: JAVA key!
Throws:: GeneralSecurityException

toJavaKey

public static PrivateKey toJavaKey(SigningPrivateKey pk)
                            throws GeneralSecurityException

Returns:: JAVA key!
Throws:: GeneralSecurityException

fromJavaKey
```
public static SigningPublicKey fromJavaKey(PublicKey pk)
                                    throws GeneralSecurityException
```
Use if SigType is unknown. For efficiency, use fromJavakey(pk, type) if type is known.

Parameters:

pk - JAVA key!

Throws:

IllegalArgumentException - on unknown type

GeneralSecurityException

Since:

0.9.18

fromJavaKey

public static SigningPublicKey fromJavaKey(PublicKey pk,
                                           SigType type)
                                    throws GeneralSecurityException

Use if SigType is known.

Parameters:: pk - JAVA key!
Throws:: GeneralSecurityException

fromJavaKey
```
public static SigningPrivateKey fromJavaKey(PrivateKey pk)
                                     throws GeneralSecurityException
```
Use if SigType is unknown. For efficiency, use fromJavakey(pk, type) if type is known.

Parameters:

pk - JAVA key!

Throws:

IllegalArgumentException - on unknown type

GeneralSecurityException

Since:

0.9.18

fromJavaKey

public static SigningPrivateKey fromJavaKey(PrivateKey pk,
                                            SigType type)
                                     throws GeneralSecurityException

Use if SigType is known.

Parameters:: pk - JAVA key!
Throws:: GeneralSecurityException

toJavaECKey

public static ECPublicKey toJavaECKey(SigningPublicKey pk)
                               throws GeneralSecurityException

Returns:: JAVA key!
Throws:: GeneralSecurityException

toJavaECKey

public static ECPrivateKey toJavaECKey(SigningPrivateKey pk)
                                throws GeneralSecurityException

Returns:: JAVA key!
Throws:: GeneralSecurityException

fromJavaKey

public static SigningPublicKey fromJavaKey(ECPublicKey pk,
                                           SigType type)
                                    throws GeneralSecurityException

Throws:: GeneralSecurityException

fromJavaKey

public static SigningPrivateKey fromJavaKey(ECPrivateKey pk,
                                            SigType type)
                                     throws GeneralSecurityException

Throws:: GeneralSecurityException

toJavaEdDSAKey

public static EdDSAPublicKey toJavaEdDSAKey(SigningPublicKey pk)
                                     throws GeneralSecurityException

Returns:: JAVA EdDSA public key!
Throws:: GeneralSecurityException
Since:: 0.9.15

toJavaEdDSAKey

public static EdDSAPrivateKey toJavaEdDSAKey(SigningPrivateKey pk)
                                      throws GeneralSecurityException

Returns:: JAVA EdDSA private key!
Throws:: GeneralSecurityException
Since:: 0.9.15

fromJavaKey

public static SigningPublicKey fromJavaKey(EdDSAPublicKey pk,
                                           SigType type)
                                    throws GeneralSecurityException

Throws:: GeneralSecurityException
Since:: 0.9.15

fromJavaKey

public static SigningPrivateKey fromJavaKey(EdDSAPrivateKey pk,
                                            SigType type)
                                     throws GeneralSecurityException

Throws:: GeneralSecurityException
Since:: 0.9.15

toJavaDSAKey

public static DSAPublicKey toJavaDSAKey(SigningPublicKey pk)
                                 throws GeneralSecurityException

Throws:: GeneralSecurityException

toJavaDSAKey

public static DSAPrivateKey toJavaDSAKey(SigningPrivateKey pk)
                                  throws GeneralSecurityException

Throws:: GeneralSecurityException

fromJavaKey

public static SigningPublicKey fromJavaKey(DSAPublicKey pk)
                                    throws GeneralSecurityException

Throws:: GeneralSecurityException

fromJavaKey

public static SigningPrivateKey fromJavaKey(DSAPrivateKey pk)
                                     throws GeneralSecurityException

Throws:: GeneralSecurityException

toJavaRSAKey

public static RSAPublicKey toJavaRSAKey(SigningPublicKey pk)
                                 throws GeneralSecurityException

Deprecated.

unused

Throws:: GeneralSecurityException

toJavaRSAKey

public static RSAPrivateKey toJavaRSAKey(SigningPrivateKey pk)
                                  throws GeneralSecurityException

As of 0.9.31, if pk is a RSASigningPrivateCrtKey, this will return a RSAPrivateCrtKey.

Throws:: GeneralSecurityException

fromJavaKey

public static SigningPublicKey fromJavaKey(RSAPublicKey pk,
                                           SigType type)
                                    throws GeneralSecurityException

Throws:: GeneralSecurityException

fromJavaKey

public static SigningPrivateKey fromJavaKey(RSAPrivateKey pk,
                                            SigType type)
                                     throws GeneralSecurityException

As of 0.9.31, if pk is a RSAPrivateCrtKey, this will return a RSASigningPrivateCrtKey.

Throws:: GeneralSecurityException

toJavaSig

public static byte[] toJavaSig(Signature sig)

Returns:: ASN.1 representation

fromJavaSig

public static Signature fromJavaSig(byte[] asn,
                                    SigType type)
                             throws SignatureException

Parameters:: asn - ASN.1 representation
Returns:: a Signature with SigType type
Throws:: SignatureException

importJavaPublicKey

public static PublicKey importJavaPublicKey(File file,
                                            SigType type)
                                     throws GeneralSecurityException,
                                            IOException

Returns:: JAVA key!
Throws:: GeneralSecurityException; IOException

importJavaPrivateKey

public static PrivateKey importJavaPrivateKey(File file,
                                              SigType type)
                                       throws GeneralSecurityException,
                                              IOException

Returns:: JAVA key!
Throws:: GeneralSecurityException; IOException

combine

static byte[] combine(BigInteger x,
                      BigInteger y,
                      int len)
               throws InvalidKeyException

Combine two BigIntegers of nominal length = len / 2

Returns:: array of exactly len bytes
Throws:: InvalidKeyException
Since:: 0.9.9, package private since 0.9.31

rectify

public static byte[] rectify(BigInteger bi,
                             int len)
                      throws InvalidKeyException

Parameters:: bi - non-negative
Returns:: array of exactly len bytes
Throws:: InvalidKeyException

sigBytesToASN1

public static byte[] sigBytesToASN1(BigInteger r,
                                    BigInteger s)

http://download.oracle.com/javase/1.5.0/docs/guide/security/CryptoSpec.html

  Signature Format: ASN.1 sequence of two INTEGER values: r and s, in that order:
                                SEQUENCE ::= { r INTEGER, s INTEGER }

  http://en.wikipedia.org/wiki/Abstract_Syntax_Notation_One
  30 -- tag indicating SEQUENCE
  xx - length in octets

  02 -- tag indicating INTEGER
  xx - length in octets
  xxxxxx - value

r and s are always non-negative. Only supports sigs up to about 65530 bytes. See code to fix BER encoding for this before you add a SigType with bigger signatures.

Throws:: IllegalArgumentException - if too big
Since:: 0.9.25, split out from sigBytesToASN1(byte[])

intToASN1
```
public static int intToASN1(byte[] d,
                            int idx,
                            int val)
```
Output an length or integer value in ASN.1 Does NOT output the tag e.g. 0x02 / 0x30

Parameters:

val - 0-65535

Returns:

the new index

Since:

0.9.25

aSN1ToBigInteger
```
public static NativeBigInteger[] aSN1ToBigInteger(byte[] asn,
                                                  int len)
                                           throws SignatureException
```
See above. Only supports sigs up to about 65530 bytes. See code to fix BER encoding for bigger than that.

Parameters:

len - nominal length of each BigInteger

Returns:

two BigIntegers

Throws:

SignatureException

Since:

0.9.25

clearCaches
```
public static void clearCaches()
```

Class SigUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toJavaKey

toJavaKey

fromJavaKey

fromJavaKey

fromJavaKey

fromJavaKey

toJavaECKey

toJavaECKey

fromJavaKey

fromJavaKey

toJavaEdDSAKey

toJavaEdDSAKey

fromJavaKey

fromJavaKey

toJavaDSAKey

toJavaDSAKey

fromJavaKey

fromJavaKey

toJavaRSAKey

toJavaRSAKey

fromJavaKey

fromJavaKey

toJavaSig

fromJavaSig

importJavaPublicKey

importJavaPrivateKey

combine

rectify

sigBytesToASN1

intToASN1

aSN1ToBigInteger

clearCaches