commonMain.org.kotlincrypto.SecureRandom.kt Maven / Gradle / Ivy
/*
* Copyright (c) 2023 Matthew Nelson
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
@file:Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING")
package org.kotlincrypto
/**
* A cryptographically strong random number generator (RNG).
* */
public expect class SecureRandom() {
/**
* Returns a [ByteArray] of size [count], filled with
* securely generated random data.
*
* @throws [IllegalArgumentException] if [count] is negative.
* @throws [SecRandomCopyException] if [nextBytesCopyTo] failed.
* */
@Throws(IllegalArgumentException::class, SecRandomCopyException::class)
public fun nextBytesOf(count: Int): ByteArray
/**
* Fills a [ByteArray] with securely generated random data.
* Does nothing if [bytes] is null or empty.
*
* @throws [SecRandomCopyException] if procurement of securely random data failed.
* */
@Throws(SecRandomCopyException::class)
public fun nextBytesCopyTo(bytes: ByteArray?)
}