io.getlime.security.powerauth.rest.api.spring.encryption.EciesEncryptionContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powerauth-restful-security-spring-annotation Show documentation
PowerAuth RESTful API Security Annotations for Spring
There is a newer version: 1.9.0
Show newest version
/*
 * PowerAuth integration libraries for RESTful API applications, examples and
 * related software components
 *
 * Copyright (C) 2018 Wultra s.r.o.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 .
 */
package io.getlime.security.powerauth.rest.api.spring.encryption;

import io.getlime.security.powerauth.crypto.lib.encryptor.ecies.model.EciesScope;
import io.getlime.security.powerauth.http.PowerAuthHttpHeader;

/**
 * Class for storing ECIES encryption context derived from HTTP headers.
 *
 * @author Roman Strobl, [email protected]
 *
 */
public class EciesEncryptionContext {

    private String applicationKey;
    private String activationId;
    private String version;
    private EciesScope eciesScope;
    private PowerAuthHttpHeader httpHeader;

    /**
     * Default constructor.
     */
    public EciesEncryptionContext() {
    }

    /**
     * Constructor with all context parameters.
     *
     * @param applicationKey Application key.
     * @param activationId Activation ID.
     * @param version PowerAuth protocol version.
     * @param httpHeader HTTP header used to derive ECIES encryption context.
     */
    public EciesEncryptionContext(String applicationKey, String activationId, String version, PowerAuthHttpHeader httpHeader) {
        this.applicationKey = applicationKey;
        this.activationId = activationId;
        this.version = version;
        this.httpHeader = httpHeader;
    }

    /**
     * Get application key.
     *
     * @return Application key.
     */
    public String getApplicationKey() {
        return applicationKey;
    }

    /**
     * Set application key.
     *
     * @param applicationKey Application key.
     */
    public void setApplicationKey(String applicationKey) {
        this.applicationKey = applicationKey;
    }

    /**
     * Get activation ID.
     *
     * @return Activation ID.
     */
    public String getActivationId() {
        return activationId;
    }

    /**
     * Set activation ID.
     *
     * @param activationId Activation ID.
     */
    public void setActivationId(String activationId) {
        this.activationId = activationId;
    }

    /**
     * Get PowerAuth protocol version.
     *
     * @return PowerAuth protocol version.
     */
    public String getVersion() {
        return version;
    }

    /**
     * Set PowerAuth protocol version.
     *
     * @param version PowerAuth protocol version.
     */
    public void setVersion(String version) {
        this.version = version;
    }

    /**
     * Get ECIES scope (application or activation).
     * @return ECIES scope.
     */
    public EciesScope getEciesScope() {
        return eciesScope;
    }

    /**
     * Set ECIES scope (application or activation).
     * @param eciesScope ECIES scope.
     */
    public void setEciesScope(EciesScope eciesScope) {
        this.eciesScope = eciesScope;
    }

    /**
     * Get PowerAuth HTTP header used for deriving ECIES encryption context.
     *
     * @return PowerAuth HTTP header used for deriving ECIES encryption context.
     */
    public PowerAuthHttpHeader getHttpHeader() {
        return httpHeader;
    }

    /**
     * Set PowerAuth HTTP header used for deriving ECIES encryption context.
     *
     * @param httpHeader PowerAuth HTTP header used for deriving ECIES encryption context.
     */
    public void setHttpHeader(PowerAuthHttpHeader httpHeader) {
        this.httpHeader = httpHeader;
    }
}