Stay organized with collections
Save and categorize content based on your preferences.
XECPrivateKeySpec
open class XECPrivateKeySpec : KeySpec
A class representing elliptic curve private keys as defined in RFC 7748, including the curve and other algorithm parameters. The private key is represented as an encoded scalar value. The decoding procedure defined in the RFC includes an operation that forces certain bits of the key to either 1 or 0. This operation is known as "pruning" or "clamping" the private key. All arrays in this spec are unpruned, and implementations will need to prune the array before using it in any numerical operations.
Summary
| Public constructors |
|
Construct a private key spec using the supplied parameters and encoded scalar value.
|
| Public methods |
| open AlgorithmParameterSpec! |
Get the algorithm parameters that define the curve and other settings.
|
| open ByteArray! |
Get the scalar value encoded as an unpruned byte array.
|
Public constructors
XECPrivateKeySpec
XECPrivateKeySpec(
params: AlgorithmParameterSpec!,
scalar: ByteArray!)
Construct a private key spec using the supplied parameters and encoded scalar value.
| Parameters |
params |
AlgorithmParameterSpec!: the algorithm parameters |
scalar |
ByteArray!: the unpruned encoded scalar value. This array is copied to protect against subsequent modification. |
| Exceptions |
java.lang.NullPointerException |
if params or scalar is null. |
Public methods
getParams
open fun getParams(): AlgorithmParameterSpec!
Get the algorithm parameters that define the curve and other settings.
getScalar
open fun getScalar(): ByteArray!
Get the scalar value encoded as an unpruned byte array. A new copy of the array is returned each time this method is called.
| Return |
ByteArray! |
the unpruned encoded scalar value |
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,["# XECPrivateKeySpec\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nXECPrivateKeySpec\n=================\n\n```\nopen class XECPrivateKeySpec : KeySpec\n```\n\n|---|-------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.security.spec.XECPrivateKeySpec](#) |\n\nA class representing elliptic curve private keys as defined in RFC 7748, including the curve and other algorithm parameters. The private key is represented as an encoded scalar value. The decoding procedure defined in the RFC includes an operation that forces certain bits of the key to either 1 or 0. This operation is known as \"pruning\" or \"clamping\" the private key. All arrays in this spec are unpruned, and implementations will need to prune the array before using it in any numerical operations.\n\nSummary\n-------\n\n| Public constructors ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [XECPrivateKeySpec](#XECPrivateKeySpec(java.security.spec.AlgorithmParameterSpec,%20kotlin.ByteArray))`(`params:` `[AlgorithmParameterSpec](/reference/kotlin/java/security/spec/AlgorithmParameterSpec)!`, `scalar:` `[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!`)` Construct a private key spec using the supplied parameters and encoded scalar value. |\n\n| Public methods ||\n|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|\n| open [AlgorithmParameterSpec](/reference/kotlin/java/security/spec/AlgorithmParameterSpec)! | [getParams](#getParams())`()` Get the algorithm parameters that define the curve and other settings. |\n| open [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)! | [getScalar](#getScalar())`()` Get the scalar value encoded as an unpruned byte array. |\n\nPublic constructors\n-------------------\n\n### XECPrivateKeySpec\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nXECPrivateKeySpec(\n params: AlgorithmParameterSpec!, \n scalar: ByteArray!)\n```\n\nConstruct a private key spec using the supplied parameters and encoded scalar value.\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `params` | [AlgorithmParameterSpec](/reference/kotlin/java/security/spec/AlgorithmParameterSpec)!: the algorithm parameters |\n| `scalar` | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!: the unpruned encoded scalar value. This array is copied to protect against subsequent modification. |\n\n| Exceptions ||\n|----------------------------------|----------------------------------|\n| `java.lang.NullPointerException` | if `params` or `scalar` is null. |\n\nPublic methods\n--------------\n\n### getParams\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getParams(): AlgorithmParameterSpec!\n```\n\nGet the algorithm parameters that define the curve and other settings.\n\n| Return ||\n|----------------------------------------------------------------------------------------|--------------------------|\n| [AlgorithmParameterSpec](/reference/kotlin/java/security/spec/AlgorithmParameterSpec)! | the algorithm parameters |\n\n### getScalar\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getScalar(): ByteArray!\n```\n\nGet the scalar value encoded as an unpruned byte array. A new copy of the array is returned each time this method is called.\n\n| Return ||\n|------------------------------------------------------------------------------------------|-----------------------------------|\n| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)! | the unpruned encoded scalar value |"]]
