1 /*
2  * Copyright (c) 1999, 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.AlgorithmParameterSpec;
30 
31 /**
32  * The interface to a public or private key in
33  * <a href="https://tools.ietf.org/rfc/rfc8017.txt">PKCS#1 v2.2</a> standard,
34  * such as those for RSA, or RSASSA-PSS algorithms.
35  *
36  * @author Jan Luehe
37  *
38  * @see RSAPublicKey
39  * @see RSAPrivateKey
40  *
41  * @since 1.3
42  */
43 
44 public interface RSAKey {
45 
46     /**
47      * Returns the modulus.
48      *
49      * @return the modulus
50      */
getModulus()51     public BigInteger getModulus();
52 
53     /**
54      * Returns the parameters associated with this key.
55      * The parameters are optional and may be either
56      * explicitly specified or implicitly created during
57      * key pair generation.
58      *
59      * @implSpec
60      * The default implementation returns {@code null}.
61      *
62      * @return the associated parameters, may be null
63      * @since 11
64      */
getParams()65     default AlgorithmParameterSpec getParams() {
66         return null;
67     }
68 }
69