com.microsoft.azure.keyvault.messagesecurity.JWEHeader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-keyvault Show documentation

This library has been replaced by new Azure SDKs, you can read about them at https://aka.ms/azsdkvalueprop. The latest libraries to interact with the Azure Key Vault service are: (1) https://search.maven.org/artifact/com.azure/azure-security-keyvault-keys. (2) https://search.maven.org/artifact/com.azure/azure-security-keyvault-secrets. (3) https://search.maven.org/artifact/com.azure/azure-security-keyvault-certificates. It is recommended that you move to the new package.

There is a newer version: 1.2.6

Show newest version

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.keyvault.messagesecurity;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.io.IOException;
import java.util.Objects;

/**
 * Json Web Encryption Header class.
 */
class JWEHeader {

    private String alg;
    private String kid;
    private String enc;

    /**
     * Constructor.
     */
    JWEHeader() {

    }

    /**
     * Constructor.
     * 
     * @param alg
     *            Encryption algorithm (for key). (Supported: RSA-OAEP)
     * @param kid
     *            Key Id
     * @param enc
     *            Encryption algorithm (for data). (Supported: A128CBC-HS256)
     */
    JWEHeader(String alg, String kid, String enc) {
        this.alg = alg;
        this.kid = kid;
        this.enc = enc;
    }

    /**
     * Compare two JWEHeaders.
     * 
     * @return true if JWEHeaders are identical.
     */
    public boolean equals(JWEHeader other) {
        return this.alg.equals(other.alg) && this.kid.equals(other.kid) && this.enc.equals(other.enc);
    }

    @Override
    public boolean equals(Object object) {
        if (!(object instanceof JWEHeader)) {
            return false;
        }

        return object == this || equals((JWEHeader) object);
    }

    /**
     * Hash code for objects.
     *
     * @return hashcode
     */
    public int hashCode() {
        return Objects.hash(this.alg, this.kid, this.enc);
    }

    /**
     * Serialize JWEHeader to json string.
     * 
     * @return Json string with serialized JWEHeader.
     */
    public String serialize() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        return mapper.writeValueAsString(this);
    }

    /**
     * Construct JWEHeader from json string.
     * 
     * @param json
     *            json string.
     * 
     * @return Constructed JWEHeader
     */
    public static JWEHeader deserialize(String json) throws IOException {
        ObjectMapper mapper = new ObjectMapper();
        return mapper.readValue(json, JWEHeader.class);
    }

    /**
     * Construct JWEHeader from base64url string.
     * 
     * @param base64
     *            base64 url string.
     * 
     * @return Constructed JWEHeader
     */
    public static JWEHeader fromBase64String(String base64) throws IOException {
        String json = MessageSecurityHelper.base64UrltoString(base64);
        return deserialize(json);
    }

    /**
     * Encryption algorithm (for key). (Supported: RSA-OAEP)
     */
    @JsonProperty("alg")
    public String alg() {
        return alg;
    }

    /**
     * Key Id.
     */
    @JsonProperty("kid")
    public String kid() {
        return kid;
    }

    /**
     * Encryption algorithm (for data). (Supported: A128CBC-HS256)
     */
    @JsonProperty("enc")
    public String enc() {
        return enc;
    }
}