ro.esolutions.licensing.encryption.PublicKeyDataProvider Maven / Gradle / Ivy

Go to download

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

The newest version!

/*
 * PublicKeyDataProvider.java from LicenseManager modified Tuesday, February 21, 2012 10:59:35 CST (-0600).
 *
 * Copyright 2010-2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ro.esolutions.licensing.encryption;

import ro.esolutions.licensing.exception.KeyNotFoundException;

/**
 * Specifies an interface for retrieving the public key file data. This
 * interface only needs to be implemented in the application using the
 * licenses. It need not be implemented in the application generating the
 * licenses.
 *
 * @author Nick Williams
 * @version 1.0.0
 * @since 1.0.0
 */
public interface PublicKeyDataProvider {
    /**
     * This method returns the data from the file containing the encrypted
     * public key from the public/private key pair. The contract for this
     * method can be fulfilled by storing the data in a byte array literal
     * in the source code itself.

     * 

     * It is imperative that you obfuscate the bytecode for the
     * implementation of this class. It is also imperative that the byte
     * array exist only for the life of this method (i.e., DO NOT store it as
     * an instance or class field).
     *
     * @return the encrypted file contents from the public key file.
     * @throws KeyNotFoundException if the key data could not be retrieved; an acceptable message or chained cause must
     *                              be provided.
     */
    byte[] getEncryptedPublicKeyData() throws KeyNotFoundException;
}