1 /* 2 * Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.net.httpserver; 27 28 import java.util.Base64; 29 30 /** 31 * BasicAuthenticator provides an implementation of HTTP Basic 32 * authentication. It is an abstract class and must be extended 33 * to provide an implementation of {@link #checkCredentials(String,String)} 34 * which is called to verify each incoming request. 35 */ 36 @jdk.Supported 37 public abstract class BasicAuthenticator extends Authenticator { 38 39 protected String realm; 40 41 /** 42 * Creates a BasicAuthenticator for the given HTTP realm 43 * @param realm The HTTP Basic authentication realm 44 * @throws NullPointerException if the realm is an empty string 45 */ 46 public BasicAuthenticator (String realm) { 47 this.realm = realm; 48 } 49 50 /** 51 * returns the realm this BasicAuthenticator was created with 52 * @return the authenticator's realm string. 53 */ 54 public String getRealm () { 55 return realm; 56 } 57 58 public Result authenticate (HttpExchange t) 59 { 60 Headers rmap = t.getRequestHeaders(); 61 /* 62 * look for auth token 63 */ 64 String auth = rmap.getFirst ("Authorization"); 65 if (auth == null) { 66 Headers map = t.getResponseHeaders(); 67 map.set ("WWW-Authenticate", "Basic realm=" + "\""+realm+"\""); 68 return new Authenticator.Retry (401); 69 } 70 int sp = auth.indexOf (' '); 71 if (sp == -1 || !auth.substring(0, sp).equals ("Basic")) { 72 return new Authenticator.Failure (401); 73 } 74 byte[] b = Base64.getDecoder().decode(auth.substring(sp+1)); 75 String userpass = new String (b); 76 int colon = userpass.indexOf (':'); 77 String uname = userpass.substring (0, colon); 78 String pass = userpass.substring (colon+1); 79 80 if (checkCredentials (uname, pass)) { 81 return new Authenticator.Success ( 82 new HttpPrincipal ( 83 uname, realm 84 ) 85 ); 86 } else { 87 /* reject the request again with 401 */ 88 89 Headers map = t.getResponseHeaders(); 90 map.set ("WWW-Authenticate", "Basic realm=" + "\""+realm+"\""); 91 return new Authenticator.Failure(401); 92 } 93 } 94 95 /** 96 * called for each incoming request to verify the 97 * given name and password in the context of this 98 * Authenticator's realm. Any caching of credentials 99 * must be done by the implementation of this method 100 * @param username the username from the request 101 * @param password the password from the request 102 * @return <code>true</code> if the credentials are valid, 103 * <code>false</code> otherwise. 104 */ 105 public abstract boolean checkCredentials (String username, String password); 106 } 107