io.getlime.security.powerauth.http.PowerAuthHttpHeader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powerauth-java-http Show documentation
PowerAuth 2.0 utility module for HTTP support
There is a newer version: 1.9.0
/*
 * Copyright 2016 Lime - HighTech Solutions s.r.o.
 *
 * 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 io.getlime.security.powerauth.http;

import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Helper class simplifying working with PowerAuth HTTP Authorization header "X-PowerAuth-Authorization".
 *
 * @author Petr Dvorak
 *
 */
public class PowerAuthHttpHeader {

    /**
     * Key representing the "pa_activation_id" in the PowerAuth authorization header.
     */
    public static final String ACTIVATION_ID = "pa_activation_id";

    /**
     * Key representing the "pa_application_key" in the PowerAuth authorization header.
     */
    public static final String APPLICATION_ID = "pa_application_key";

    /**
     * Key representing the "pa_signature" in the PowerAuth authorization header.
     */
    public static final String SIGNATURE = "pa_signature";

    /**
     * Key representing the "pa_signature_type" in the PowerAuth authorization header.
     */
    public static final String SIGNATURE_TYPE = "pa_signature_type";

    /**
     * Key representing the "pa_nonce" in the PowerAuth authorization header.
     */
    public static final String NONCE = "pa_nonce";

    /**
     * Key representing the "pa_version" in the PowerAuth authorization header.
     */
    public static final String VERSION = "pa_version";

    /**
     * Name of the PowerAuth authorization header, "X-PowerAuth-Authorization".
     */
    public static final String HEADER_NAME = "X-PowerAuth-Authorization";

    private static final String POWERAUTH_PREFIX = "PowerAuth ";

    /**
     * Parse the PowerAuth authorization header and return map with values.
     * @param xPowerAuthSignatureHeader HTTP header with PowerAuth authorization.
     * @return Map with parsed header values.
     */
    public static Map parsePowerAuthSignatureHTTPHeader(String xPowerAuthSignatureHeader) {
        if (xPowerAuthSignatureHeader == null) {
            return new HashMap<>(); // invalid map with empty values works better than null here
        }
        xPowerAuthSignatureHeader = xPowerAuthSignatureHeader.trim();
        if (!xPowerAuthSignatureHeader.startsWith(POWERAUTH_PREFIX)) {
            return new HashMap<>(); // invalid map with empty values works better than null here
        }
        xPowerAuthSignatureHeader = xPowerAuthSignatureHeader.substring(POWERAUTH_PREFIX.length()).trim();

        // Parse the key / value pairs
        Map result = new HashMap<>();
        Pattern p = Pattern.compile("(\\w+)=\"*((?<=\")[^\"]+(?=\")|([^\\s]+)),*\"*");
        Matcher m = p.matcher(xPowerAuthSignatureHeader);
        while (m.find()) {
            result.put(m.group(1), m.group(2));
        }

        return result;
    }

    private static String headerField(String key, String value) {
        return key + "=\"" + value + "\"";
    }

    /**
     * Generate a valid PowerAuth Authorization header based on provided parameters.
     * @param activationId An ID of an activation.
     * @param applicationId An ID of an application.
     * @param nonce Random nonce.
     * @param signatureType Signature type.
     * @param signature Signature.
     * @param version PowerAuth protocol version.
     * @return Value to be used in X-PowerAuth-Authorization HTTP header.
     */
    public static String getPowerAuthSignatureHTTPHeader(String activationId, String applicationId, String nonce, String signatureType, String signature, String version) {
        String result = POWERAUTH_PREFIX
                + headerField(ACTIVATION_ID, activationId) + ", "
                + headerField(APPLICATION_ID, applicationId) + ", "
                + headerField(NONCE, nonce) + ", "
                + headerField(SIGNATURE_TYPE, signatureType) + ", "
                + headerField(SIGNATURE, signature) + ", "
                + headerField(VERSION, version);
        return result;
    }

}