/*
 * Copyright 2016 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.auth.oauth2;

import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.json.JsonObject;

import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

Helper class for processing Keycloak principal.
Author:
Eric Zhao
Deprecated:
Use the User principal to access this data as this class is not guaranteed to be secure as no cryptographic signatures are verified./**
 * Helper class for processing Keycloak principal.
 *
 * @author Eric Zhao
 * @deprecated Use the {@link io.vertx.ext.auth.User} principal to access this data as this class is not guaranteed to
 * be secure as no cryptographic signatures are verified.
 */
@VertxGen
@Deprecated
public interface KeycloakHelper {

  
Get raw `id_token` string from the principal.
Params:
principal – user principal
Returns:
the raw id token string/**
   * Get raw `id_token` string from the principal.
   *
   * @param principal user principal
   * @return the raw id token string
   */
  static String rawIdToken(JsonObject principal) {
    return principal.getString("id_token");
  }

  
Get decoded `id_token` from the principal.
Params:
principal – user principal
Returns:
the id token/**
   * Get decoded `id_token` from the principal.
   *
   * @param principal user principal
   * @return the id token
   */
  static JsonObject idToken(JsonObject principal) {
    return parseToken(rawIdToken(principal));
  }

  
Get raw `access_token` string from the principal.
Params:
principal – user principal
Returns:
the raw access token string/**
   * Get raw `access_token` string from the principal.
   *
   * @param principal user principal
   * @return the raw access token string
   */
  static String rawAccessToken(JsonObject principal) {
    return principal.getString("access_token");
  }

  
Get decoded `access_token` from the principal.
Params:
principal – user principal
Returns:
the access token/**
   * Get decoded `access_token` from the principal.
   *
   * @param principal user principal
   * @return the access token
   */
  static JsonObject accessToken(JsonObject principal) {
    return parseToken(rawAccessToken(principal));
  }

  // helper methods for getting fields from the principal

  static int authTime(JsonObject principal) {
    return idToken(principal).getInteger("auth_time");
  }

  static String sessionState(JsonObject principal) {
    return idToken(principal).getString("session_state");
  }

  static String acr(JsonObject principal) {
    return idToken(principal).getString("acr");
  }

  static String name(JsonObject principal) {
    return idToken(principal).getString("name");
  }

  static String email(JsonObject principal) {
    return idToken(principal).getString("email");
  }

  static String preferredUsername(JsonObject principal) {
    return idToken(principal).getString("preferred_username");
  }

  static String nickName(JsonObject principal) {
    return idToken(principal).getString("nickname");
  }

  @SuppressWarnings("unchecked")
  static Set<String> allowedOrigins(JsonObject principal) {
    List<String> allowedOrigins = accessToken(principal)
      .getJsonArray("allowed-origins")
      .getList();
    return new HashSet<>(allowedOrigins);
  }

  
Parse the token string with base64 decoder.
This will only obtain the "payload" part of the token.
Params:
token – token string
Returns:
token payload json object/**
   * Parse the token string with base64 decoder.
   * This will only obtain the "payload" part of the token.
   *
   * @param token token string
   * @return token payload json object
   */
  static JsonObject parseToken(String token) {
    if (token == null) {
      return null;
    }
    String[] parts = token.split("\\.");
    if (parts.length < 2 || parts.length > 3) {
      throw new IllegalArgumentException("Parsing error");
    }
    try {
      String decoded = new String(Base64.getUrlDecoder().decode(parts[1]), StandardCharsets.UTF_8);
      return new JsonObject(decoded); // get "payload" part
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }
}