com.kloudtek.kryptotek.Key Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kryptotek-core Show documentation

Kryptotek provides an easy to use abstraction layer for cryptographic functions

The newest version!

/*
 * Copyright (c) 2016 Kloudtek Ltd
 */

package com.kloudtek.kryptotek;

import com.kloudtek.kryptotek.key.KeyType;

/**
 * Created by yannick on 22/11/2014.
 */
public interface Key {
    KeyType getType();

    /**
     * Return the key in encoded format, using the key's default encoding type (which depends on the key and engine).
     * @return encoded key, or null if no encoded key is supported
     */
    EncodedKey getEncoded();

    /**
     * Return the key in encoded format, using the key's default encoding type
     * @param format Format
     * @return Encoded key
     * @throws InvalidKeyEncodingException If an invalid key encoding format was specified
     */
    EncodedKey getEncoded( EncodedKey.Format format ) throws InvalidKeyEncodingException;

    byte[] serialize();

    /**
     * Destroy all key data from memory
     */
    void destroy();

    /**
     * Get the engine that created this key
     * @return {@link com.kloudtek.kryptotek.CryptoEngine} implementation
     */
    CryptoEngine getCryptoEngine();
}