View Javadoc
1   /*
2    * Copyright (c) 1996, 2013, 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  
30  /**
31   * Interface to a DSA-specific set of key parameters, which defines a
32   * DSA <em>key family</em>. DSA (Digital Signature Algorithm) is defined
33   * in NIST's FIPS-186.
34   *
35   * @see DSAKey
36   * @see java.security.Key
37   * @see java.security.Signature
38   *
39   * @author Benjamin Renaud
40   * @author Josh Bloch
41   */
42  public interface DSAParams {
43  
44      /**
45       * Returns the prime, {@code p}.
46       *
47       * @return the prime, {@code p}.
48       */
49      public BigInteger getP();
50  
51      /**
52       * Returns the subprime, {@code q}.
53       *
54       * @return the subprime, {@code q}.
55       */
56      public BigInteger getQ();
57  
58      /**
59       * Returns the base, {@code g}.
60       *
61       * @return the base, {@code g}.
62       */
63      public BigInteger getG();
64  }