aaa-shiro/impl/src/main/java/org/opendaylight/aaa/shiro/realm/util/http/header/HeaderUtils.java

   1 /*
   2  * Copyright (c) 2017 Inocybe Technologies and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.aaa.shiro.realm.util.http.header;
  10
  11 import java.nio.charset.StandardCharsets;
  12 import java.util.ArrayList;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16 import org.apache.shiro.codec.Base64;
  17 import org.opendaylight.aaa.shiro.tokenauthrealm.auth.HttpBasicAuth;
  18
  19 /**
  20  * Utilities for HTTP header manipulation.
  21  */
  22 public final class HeaderUtils {
  23
  24     public static final String USERNAME_DOMAIN_SEPARATOR = "@";
  25
  26     private HeaderUtils() {
  27     }
  28
  29     /**
  30      * Returns a string containing the encoded token.
  31      *
  32      * @param credentialToken token to encode
  33      * @return Base64 encoded token
  34      */
  35     public static String getEncodedToken(final String credentialToken) {
  36         return Base64.encodeToString(credentialToken.getBytes(StandardCharsets.UTF_8));
  37     }
  38
  39     /**
  40      * Bridge new to old style <code>TokenAuth</code> interface.
  41      *
  42      * @param username The request username
  43      * @param password The request password
  44      * @param domain   The request domain
  45      * @return <code>username:password:domain</code>
  46      */
  47     public static String getUsernamePasswordDomainString(final String username, final String password,
  48                                                          final String domain) {
  49         return username + HttpBasicAuth.AUTH_SEP + password + HttpBasicAuth.AUTH_SEP + domain;
  50     }
  51
  52     /**
  53      * Returns a string with the authorization header.
  54      *
  55      * @param encodedToken encoded token
  56      * @return Basic <code>encodedToken</code>
  57      */
  58     public static String getTokenAuthHeader(final String encodedToken) {
  59         return HttpBasicAuth.BASIC_PREFIX + encodedToken;
  60     }
  61
  62     /**
  63      * Returns a map with all the list of headers for the given token.
  64      *
  65      * @param tokenAuthHeader token authorization header
  66      * @return a map with the basic auth header
  67      */
  68     public static Map<String, List<String>> formHeadersWithToken(final String tokenAuthHeader) {
  69         final Map<String, List<String>> headers = new HashMap<>();
  70         final List<String> headerValue = new ArrayList<>();
  71         headerValue.add(tokenAuthHeader);
  72         headers.put(HttpBasicAuth.AUTH_HEADER, headerValue);
  73         return headers;
  74     }
  75
  76     /**
  77      * Adapter between basic authentication mechanism and existing
  78      * <code>TokenAuth</code> interface.
  79      *
  80      * @param username Username from the request
  81      * @param password Password from the request
  82      * @param domain   Domain from the request
  83      * @return input map for <code>TokenAuth.validate()</code>
  84      */
  85     public static Map<String, List<String>> formHeaders(final String username, final String password,
  86                                                         final String domain) {
  87         String usernamePasswordToken = getUsernamePasswordDomainString(username, password, domain);
  88         String encodedToken = getEncodedToken(usernamePasswordToken);
  89         String tokenAuthHeader = getTokenAuthHeader(encodedToken);
  90         return formHeadersWithToken(tokenAuthHeader);
  91     }
  92
  93     /**
  94      * Extract username from the form <code>user</code> or <code>user@domain</code>.
  95      *
  96      * @param possiblyQualifiedUsername <code>user</code> or <code>user@domain</code>
  97      * @return username
  98      */
  99     public static String extractUsername(final String possiblyQualifiedUsername) {
 100         if (possiblyQualifiedUsername.contains(USERNAME_DOMAIN_SEPARATOR)) {
 101             final String[] qualifiedUserArray = possiblyQualifiedUsername.split(USERNAME_DOMAIN_SEPARATOR);
 102             return qualifiedUserArray[0];
 103         }
 104         return possiblyQualifiedUsername;
 105     }
 106
 107     /**
 108      * Extract domain from the form <code>user</code> or <code>user@domain</code>.
 109      *
 110      * @param possiblyQualifiedUsername <code>user</code> or <code>user@domain</code>
 111      * @return the domain or <code>HttpBasicAuth.DEFAULT_DOMAIN</code>
 112      */
 113     public static String extractDomain(final String possiblyQualifiedUsername) {
 114         if (possiblyQualifiedUsername.contains(USERNAME_DOMAIN_SEPARATOR)) {
 115             final String[] qualifiedUserArray = possiblyQualifiedUsername.split(USERNAME_DOMAIN_SEPARATOR);
 116             return qualifiedUserArray[1];
 117         }
 118         return HttpBasicAuth.DEFAULT_DOMAIN;
 119     }
 120 }