io.github.astrapi69.crypt.data.model.SharedSecretInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crypt-data Show documentation

Utility project that provides data beans, writers and readers for encryption and decryption

There is a newer version: 10

/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package io.github.astrapi69.crypt.data.model;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.FieldDefaults;
import lombok.experimental.SuperBuilder;

/**
 * Data class representing shared secret information used in cryptographic operations.
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@SuperBuilder(toBuilder = true)
@FieldDefaults(level = AccessLevel.PRIVATE)
public class SharedSecretInfo
{

	/**
	 * Information about the private key.
	 */
	KeyInfo privateKeyInfo;

	/**
	 * Information about the public key.
	 */
	KeyInfo publicKeyInfo;

	/**
	 * The algorithm used for key agreement.
	 */
	String keyAgreementAlgorithm;

	/**
	 * The algorithm used for the secret key.
	 */
	String secretKeyAlgorithm;

	/**
	 * The provider for the cryptographic algorithms.
	 */
	String provider;

	/**
	 * The algorithm used for encryption and decryption.
	 */
	String cipherAlgorithm;

	/**
	 * The initialization vector for the cipher algorithm.
	 */
	byte[] iv;
}