Stay organized with collections Save and categorize content based on your preferences.
DHParameterSpec
open class DHParameterSpec : AlgorithmParameterSpec
This class specifies the set of parameters used with the Diffie-Hellman algorithm, as specified in PKCS #3: Diffie-Hellman Key-Agreement Standard.
A central authority generates parameters and gives them to the two entities seeking to generate a secret key. The parameters are a prime p, a base g, and optionally the length in bits of the private value, l.
It is possible that more than one instance of parameters may be generated by a given central authority, and that there may be more than one central authority. Indeed, each individual may be its own central authority, with different entities having different parameters.
Note that this class does not perform any validation on specified parameters. Thus, the specified values are returned directly even if they are null.
Summary
| Public constructors |
| Constructs a parameter set for Diffie-Hellman, using a prime modulus p and a base generator g. |
| Constructs a parameter set for Diffie-Hellman, using a prime modulus p, a base generator g, and the size in bits, l, of the random exponent (private value). |
| Public methods |
| open BigInteger! | Returns the base generator g. |
| open Int | Returns the size in bits, l, of the random exponent (private value). |
| open BigInteger! | Returns the prime modulus p. |
Public constructors
DHParameterSpec
DHParameterSpec(
p: BigInteger!,
g: BigInteger!)
Constructs a parameter set for Diffie-Hellman, using a prime modulus p and a base generator g.
DHParameterSpec
DHParameterSpec(
p: BigInteger!,
g: BigInteger!,
l: Int)
Constructs a parameter set for Diffie-Hellman, using a prime modulus p, a base generator g, and the size in bits, l, of the random exponent (private value).
| Parameters |
p | BigInteger!: the prime modulus |
g | BigInteger!: the base generator |
l | Int: the size in bits of the random exponent (private value) |
Public methods
getG
open fun getG(): BigInteger!
Returns the base generator g.
getL
open fun getL(): Int
Returns the size in bits, l, of the random exponent (private value).
| Return |
Int | the size in bits, l, of the random exponent (private value), or 0 if this size has not been set |
getP
open fun getP(): BigInteger!
Returns the prime modulus p.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# DHParameterSpec\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nDHParameterSpec\n===============\n\n```\nopen class DHParameterSpec : AlgorithmParameterSpec\n```\n\n|---|----------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [javax.crypto.spec.DHParameterSpec](#) |\n\nThis class specifies the set of parameters used with the Diffie-Hellman algorithm, as specified in PKCS #3: *Diffie-Hellman Key-Agreement Standard*.\n\nA central authority generates parameters and gives them to the two entities seeking to generate a secret key. The parameters are a prime `p`, a base `g`, and optionally the length in bits of the private value, `l`.\n\nIt is possible that more than one instance of parameters may be generated by a given central authority, and that there may be more than one central authority. Indeed, each individual may be its own central authority, with different entities having different parameters.\n\nNote that this class does not perform any validation on specified parameters. Thus, the specified values are returned directly even if they are null.\n\nSummary\n-------\n\n| Public constructors ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [DHParameterSpec](#DHParameterSpec(java.math.BigInteger,%20java.math.BigInteger))`(`p:` `[BigInteger](../../../java/math/BigInteger.html#)!`, `g:` `[BigInteger](../../../java/math/BigInteger.html#)!`)` Constructs a parameter set for Diffie-Hellman, using a prime modulus `p` and a base generator `g`. |\n| [DHParameterSpec](#DHParameterSpec(java.math.BigInteger,%20java.math.BigInteger,%20kotlin.Int))`(`p:` `[BigInteger](../../../java/math/BigInteger.html#)!`, `g:` `[BigInteger](../../../java/math/BigInteger.html#)!`, `l:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Constructs a parameter set for Diffie-Hellman, using a prime modulus `p`, a base generator `g`, and the size in bits, `l`, of the random exponent (private value). |\n\n| Public methods ||\n|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|\n| open [BigInteger](../../../java/math/BigInteger.html#)! | [getG](#getG())`()` Returns the base generator `g`. |\n| open [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getL](#getL())`()` Returns the size in bits, `l`, of the random exponent (private value). |\n| open [BigInteger](../../../java/math/BigInteger.html#)! | [getP](#getP())`()` Returns the prime modulus `p`. |\n\nPublic constructors\n-------------------\n\n### DHParameterSpec\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nDHParameterSpec(\n p: BigInteger!, \n g: BigInteger!)\n```\n\nConstructs a parameter set for Diffie-Hellman, using a prime modulus `p` and a base generator `g`.\n\n| Parameters ||\n|-----|------------------------------------------------------------------------|\n| `p` | [BigInteger](../../../java/math/BigInteger.html#)!: the prime modulus |\n| `g` | [BigInteger](../../../java/math/BigInteger.html#)!: the base generator |\n\n### DHParameterSpec\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nDHParameterSpec(\n p: BigInteger!, \n g: BigInteger!, \n l: Int)\n```\n\nConstructs a parameter set for Diffie-Hellman, using a prime modulus `p`, a base generator `g`, and the size in bits, `l`, of the random exponent (private value).\n\n| Parameters ||\n|-----|-------------------------------------------------------------------------------------------------------------------------------------|\n| `p` | [BigInteger](../../../java/math/BigInteger.html#)!: the prime modulus |\n| `g` | [BigInteger](../../../java/math/BigInteger.html#)!: the base generator |\n| `l` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the size in bits of the random exponent (private value) |\n\nPublic methods\n--------------\n\n### getG\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getG(): BigInteger!\n```\n\nReturns the base generator `g`.\n\n| Return ||\n|----------------------------------------------------|------------------------|\n| [BigInteger](../../../java/math/BigInteger.html#)! | the base generator `g` |\n\n### getL\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getL(): Int\n```\n\nReturns the size in bits, `l`, of the random exponent (private value).\n\n| Return ||\n|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | the size in bits, `l`, of the random exponent (private value), or 0 if this size has not been set |\n\n### getP\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getP(): BigInteger!\n```\n\nReturns the prime modulus `p`.\n\n| Return ||\n|----------------------------------------------------|-----------------------|\n| [BigInteger](../../../java/math/BigInteger.html#)! | the prime modulus `p` |"]]
