1 /*
   2  * Copyright (c) 2001, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.security.interfaces;
  27 
  28 import java.math.BigInteger;
  29 import java.security.spec.RSAOtherPrimeInfo;
  30 
  31 /**
  32  * The interface to an RSA multi-prime private key, as defined in the
  33  * <a href="https://tools.ietf.org/rfc/rfc8017.txt">PKCS#1 v2.2</a> standard,
  34  * using the <i>Chinese Remainder Theorem</i> (CRT) information values.
  35  *
  36  * @author Valerie Peng
  37  *
  38  *
  39  * @see java.security.spec.RSAPrivateKeySpec
  40  * @see java.security.spec.RSAMultiPrimePrivateCrtKeySpec
  41  * @see RSAPrivateKey
  42  * @see RSAPrivateCrtKey
  43  *
  44  * @since 1.4
  45  */
  46 
  47 public interface RSAMultiPrimePrivateCrtKey extends RSAPrivateKey {
  48 
  49     /**
  50      * The type fingerprint that is set to indicate
  51      * serialization compatibility with a previous
  52      * version of the type.
  53      */
  54     static final long serialVersionUID = 618058533534628008L;
  55 
  56     /**
  57      * Returns the public exponent.
  58      *
  59      * @return the public exponent.
  60      */
  61     public BigInteger getPublicExponent();
  62 
  63     /**
  64      * Returns the primeP.
  65      *
  66      * @return the primeP.
  67      */
  68     public BigInteger getPrimeP();
  69 
  70     /**
  71      * Returns the primeQ.
  72      *
  73      * @return the primeQ.
  74      */
  75     public BigInteger getPrimeQ();
  76 
  77     /**
  78      * Returns the primeExponentP.
  79      *
  80      * @return the primeExponentP.
  81      */
  82     public BigInteger getPrimeExponentP();
  83 
  84     /**
  85      * Returns the primeExponentQ.
  86      *
  87      * @return the primeExponentQ.
  88      */
  89     public BigInteger getPrimeExponentQ();
  90 
  91     /**
  92      * Returns the crtCoefficient.
  93      *
  94      * @return the crtCoefficient.
  95      */
  96     public BigInteger getCrtCoefficient();
  97 
  98     /**
  99      * Returns the otherPrimeInfo or null if there are only
 100      * two prime factors (p and q).
 101      *
 102      * @return the otherPrimeInfo.
 103      */
 104     public RSAOtherPrimeInfo[] getOtherPrimeInfo();
 105 }