/*  _____ _
 * |_   _| |_  _ _ ___ ___ _ __  __ _
 *   | | | ' \| '_/ -_) -_) '  \/ _` |_
 *   |_| |_||_|_| \___\___|_|_|_\__,_(_)
 *
 * Threema Java Client
 * Copyright (c) 2013-2020 Threema GmbH
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

package ch.threema.client;

/**
 * Interface for identity stores.
 */
public interface IdentityStoreInterface {

	/**
	 * Encrypt the given plaintext with the private key stored in this identity store.
	 *
	 * @param plaintext plaintext to be encrypted
	 * @param nonce nonce to be used for encryption (normally random)
	 * @param receiverPublicKey public key of receiver
	 * @return encrypted data (larger than input plaintext), or null if encryption failed
	 */
	byte[] encryptData(byte[] plaintext, byte[] nonce, byte[] receiverPublicKey);

	/**
	 * Decrypt the given plaintext with the private key stored in this identity store.
	 *
	 * @param ciphertext ciphertext to be decrypted
	 * @param nonce nonce that was used for encryption
	 * @param senderPublicKey public key of sender
	 * @return decrypted data (smaller than input ciphertext), or null if decryption failed
	 */
	byte[] decryptData(byte[] ciphertext, byte[] nonce, byte[] senderPublicKey);

	String getIdentity();
	String getServerGroup();
	byte[] getPublicKey();
	String getPublicNickname();

	void storeIdentity(String identity, String serverGroup, byte[] publicKey, byte[] privateKey);
}
