org.xwiki.crypto.params.cipher.asymmetric.AsymmetricKeyParameters Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-crypto-common Show documentation

API common to all crypto modules

There is a newer version: 17.0.0-rc-1

Show newest version

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.crypto.params.cipher.asymmetric;

/**
 * Asymmetric key parameters.
 *
 * @version $Id: 3bafd78b65ba16dbb859b8f3775051b746c0ce6b $
 * @since 5.4M1
 */
public interface AsymmetricKeyParameters extends AsymmetricCipherParameters
{
    /**
     * @return true if this key is a private key.
     */
    boolean isPrivate();

    /**
     * @return the ASN.1 encoded form of this key or null if the key could not be encoded.
     */
    byte[] getEncoded();
}