org.mule.module.pgp.PGPKeyRing Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mule-module-pgp Show documentation

A Mule implementation of PGP security using cryptix libraries.

The newest version!

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.module.pgp;

import org.bouncycastle.openpgp.PGPPublicKey;
import org.bouncycastle.openpgp.PGPPublicKeyRingCollection;
import org.bouncycastle.openpgp.PGPSecretKey;
import org.bouncycastle.openpgp.PGPSecretKeyRingCollection;

public interface PGPKeyRing
{
    String getSecretPassphrase();

    /**
     * @return the PGPSecretKey obtained from the secretAliasId if it was defined. Otherwise, null.
     */
    PGPSecretKey getConfiguredSecretKey();

    PGPPublicKey getPublicKey(String principalId);

    /**
     * @return all the secretKeys found in the secretKeyFile.
     */
    PGPSecretKeyRingCollection getSecretKeys();

    /**
     * @return all the publicKeys found in the publicSecretKeyFile.
     */
    PGPPublicKeyRingCollection getPublicKeys();
}