Package org.bouncycastle.pqc.crypto.mceliece

## Class McElieceCCA2PrivateKeyParameters

- java.lang.Object
- - org.bouncycastle.crypto.params.AsymmetricKeyParameter
  - - org.bouncycastle.pqc.crypto.mceliece.McElieceCCA2KeyParameters
    - - org.bouncycastle.pqc.crypto.mceliece.McElieceCCA2PrivateKeyParameters

- All Implemented Interfaces:
    `CipherParameters`

      public class McElieceCCA2PrivateKeyParameters
      extends McElieceCCA2KeyParameters

- - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `McElieceCCA2PrivateKeyParameters​(int n, int k, GF2mField field, PolynomialGF2mSmallM gp, GF2Matrix canonicalCheckMatrix, Permutation p, java.lang.String digest)` | Constructor.
    `McElieceCCA2PrivateKeyParameters​(int n, int k, GF2mField field, PolynomialGF2mSmallM gp, Permutation p, java.lang.String digest)` | Constructor.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `GF2mField` | `getField()` |
    `PolynomialGF2mSmallM` | `getGoppaPoly()` |
    `GF2Matrix` | `getH()` |
    `int` | `getK()` |
    `int` | `getN()` |
    `Permutation` | `getP()` |
    `PolynomialGF2mSmallM[]` | `getQInv()` |
    `int` | `getT()` |

    - ### Methods inherited from class org.bouncycastle.pqc.crypto.mceliece.McElieceCCA2KeyParameters

      `getDigest`

    - ### Methods inherited from class org.bouncycastle.crypto.params.AsymmetricKeyParameter

      `isPrivate`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### McElieceCCA2PrivateKeyParameters

          public McElieceCCA2PrivateKeyParameters​(int n,
                                                  int k,
                                                  GF2mField field,
                                                  PolynomialGF2mSmallM gp,
                                                  Permutation p,
                                                  java.lang.String digest)

      Constructor.
      Parameters:
        `n` - the length of the code
        `k` - the dimension of the code
        `field` - the finite field `GF(2m)`
        `gp` - the irreducible Goppa polynomial
        `p` - the permutation
        `digest` - name of digest algorithm

    - #### McElieceCCA2PrivateKeyParameters

          public McElieceCCA2PrivateKeyParameters​(int n,
                                                  int k,
                                                  GF2mField field,
                                                  PolynomialGF2mSmallM gp,
                                                  GF2Matrix canonicalCheckMatrix,
                                                  Permutation p,
                                                  java.lang.String digest)

      Constructor.
      Parameters:
        `n` - the length of the code
        `k` - the dimension of the code
        `field` - the finite field `GF(2m)`
        `gp` - the irreducible Goppa polynomial
        `canonicalCheckMatrix` - the canonical check matrix
        `p` - the permutation
        `digest` - name of digest algorithm

  - ### Method Detail

    - #### getN

          public int getN()

      Returns:
        the length of the code

    - #### getK

          public int getK()

      Returns:
        the dimension of the code

    - #### getT

          public int getT()

      Returns:
        the degree of the Goppa polynomial (error correcting capability)

    - #### getField

          public GF2mField getField()

      Returns:
        the finite field

    - #### getGoppaPoly

          public PolynomialGF2mSmallM getGoppaPoly()

      Returns:
        the irreducible Goppa polynomial

    - #### getP

          public Permutation getP()

      Returns:
        the permutation P

    - #### getH

          public GF2Matrix getH()

      Returns:
        the canonical check matrix H

    - #### getQInv

          public PolynomialGF2mSmallM[] getQInv()

      Returns:
        the matrix used to compute square roots in `(GF(2^m))^t`