com.adobe.aio.auth.JwtContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aio-lib-java-core Show documentation
Adobe I/O - Java SDK - Core Library
There is a newer version: 2.0.0
/*
 * Copyright 2023 Adobe. All rights reserved.
 * This file is licensed to you 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 REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package com.adobe.aio.auth;

import java.security.PrivateKey;
import java.util.HashSet;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;
import java.util.Set;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import com.fasterxml.jackson.annotation.JsonIgnore;

import static com.adobe.aio.util.FileUtil.*;

/**
 * JWT Authentication context.
 */
public class JwtContext implements Context {
  public static final String CREDENTIAL_ID = "aio_credential_id";
  public static final String CLIENT_SECRET = "aio_client_secret";
  public static final String TECHNICAL_ACCOUNT_ID = "aio_technical_account_id";
  public static final String META_SCOPES = "aio_meta_scopes";

  private final String credentialId;
  private final String technicalAccountId;
  private final Set metascopes;
  private final String clientSecret;
  private final PrivateKey privateKey;

  public JwtContext(final String credentialId, final String clientSecret, final String technicalAccountId,
                    final Set metascopes, final PrivateKey privateKey) {
    this.credentialId = credentialId;
    this.clientSecret = clientSecret;
    this.technicalAccountId = technicalAccountId;
    this.metascopes = metascopes;
    this.privateKey = privateKey;
  }

  public static Builder builder() {
    return new Builder();
  }

  public void validate() {
    if (StringUtils.isEmpty(clientSecret)) {
      throw new IllegalStateException("Your `JwtContext` is missing a clientSecret");
    }
    if (StringUtils.isEmpty(technicalAccountId)) {
      throw new IllegalStateException("Your `JwtContext` is missing a technicalAccountId");
    }
    if (metascopes.isEmpty()) {
      throw new IllegalStateException("Your `JwtContext` is missing a metascope");
    }
    if (privateKey == null) {
      throw new IllegalStateException("Your `JwtContext` is missing a privateKey");
    }
  }

  public String getCredentialId() {
    return credentialId;
  }

  public String getTechnicalAccountId() {
    return technicalAccountId;
  }

  public Set getMetascopes() {
    return metascopes;
  }

  // we want to avoid serializing this secret
  @JsonIgnore
  public String getClientSecret() {
    return clientSecret;
  }

  public boolean isClientSecretDefined() {
    return !StringUtils.isEmpty(this.clientSecret);
  }

  // we want to avoid serializing this secret
  @JsonIgnore
  public PrivateKey getPrivateKey() {
    return privateKey;
  }

  public boolean isPrivateKeyDefined() {
    return (this.privateKey != null);
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;

    JwtContext that = (JwtContext) o;

    if (!Objects.equals(credentialId, that.credentialId)) return false;
    if (!Objects.equals(technicalAccountId, that.technicalAccountId))
      return false;
    if (!Objects.equals(metascopes, that.metascopes)) return false;
    if (!Objects.equals(clientSecret, that.clientSecret)) return false;
    return Objects.equals(privateKey, that.privateKey);
  }

  @Override
  public int hashCode() {
    int result = credentialId != null ? credentialId.hashCode() : 0;
    result = 31 * result + (technicalAccountId != null ? technicalAccountId.hashCode() : 0);
    result = 31 * result + (metascopes != null ? metascopes.hashCode() : 0);
    result = 31 * result + (clientSecret != null ? clientSecret.hashCode() : 0);
    result = 31 * result + (privateKey != null ? privateKey.hashCode() : 0);
    return result;
  }

  @Override
  public String toString() {
    return "JwtContext{" +
        "credentialId='" + credentialId + '\'' +
        ", technicalAccountId='" + technicalAccountId + '\'' +
        ", metascopes=" + metascopes +
        '}';
  }

  public static class Builder {

    private String credentialId;
    private String clientSecret;
    private String technicalAccountId;
    private PrivateKey privateKey;
    private final Set metascopes = new HashSet<>();

    public Builder credentialId(final String credentialId) {
      this.credentialId = credentialId;
      return this;
    }

    public Builder clientSecret(final String clientSecret) {
      this.clientSecret = clientSecret;
      return this;
    }

    public Builder technicalAccountId(final String technicalAccountId) {
      this.technicalAccountId = technicalAccountId;
      return this;
    }

    public Builder addMetascope(final String metascope) {
      this.metascopes.add(metascope);
      return this;
    }

    public Builder privateKey(final PrivateKey privateKey) {
      this.privateKey = privateKey;
      return this;
    }

    public Builder configMap(final Map configMap) {
      this
          .credentialId(configMap.get(CREDENTIAL_ID))
          .clientSecret(configMap.get(CLIENT_SECRET))
          .technicalAccountId(configMap.get(TECHNICAL_ACCOUNT_ID));
      if (!StringUtils.isEmpty(configMap.get(META_SCOPES))) {
        String[] metascopeArray = configMap.get(META_SCOPES).split(",");
        for (String metascope : metascopeArray) {
          this.addMetascope(metascope);
        }
      }
      return this;
    }

    public Builder systemEnv() {
      return configMap(System.getenv());
    }

    public Builder propertiesPath(final String propertiesPath) {
      return properties(
          readPropertiesFromFile(propertiesPath)
              .orElse(readPropertiesFromClassPath(propertiesPath)));
    }

    public Builder properties(final Properties properties) {
      return configMap(getMapFromProperties(properties));
    }

    public JwtContext build() {
      return new JwtContext(credentialId, clientSecret, technicalAccountId, metascopes, privateKey);
    }
  }
}