View Javadoc
1 /* 2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/BasicScheme.java,v 1.4.2.1 2003/08/13 19:58:14 olegk Exp $ 3 * $Revision: 1.4.2.1 $ 4 * $Date: 2003/08/13 19:58:14 $ 5 * 6 * ==================================================================== 7 * 8 * The Apache Software License, Version 1.1 9 * 10 * Copyright (c) 2002-2003 The Apache Software Foundation. All rights 11 * reserved. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in 22 * the documentation and/or other materials provided with the 23 * distribution. 24 * 25 * 3. The end-user documentation included with the redistribution, if 26 * any, must include the following acknowlegement: 27 * "This product includes software developed by the 28 * Apache Software Foundation (http://www.apache.org/)." 29 * Alternately, this acknowlegement may appear in the software itself, 30 * if and wherever such third-party acknowlegements normally appear. 31 * 32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software 33 * Foundation" must not be used to endorse or promote products derived 34 * from this software without prior written permission. For written 35 * permission, please contact apache@apache.org. 36 * 37 * 5. Products derived from this software may not be called "Apache" 38 * nor may "Apache" appear in their names without prior written 39 * permission of the Apache Group. 40 * 41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 52 * SUCH DAMAGE. 53 * ==================================================================== 54 * 55 * This software consists of voluntary contributions made by many 56 * individuals on behalf of the Apache Software Foundation. For more 57 * information on the Apache Software Foundation, please see 58 * <http://www.apache.org/>. 59 * 60 * [Additional notices, if required by prior licensing conditions] 61 * 62 */ 63 64 package org.apache.commons.httpclient.auth; 65 66 import org.apache.commons.httpclient.HttpConstants; 67 import org.apache.commons.httpclient.Credentials; 68 import org.apache.commons.httpclient.UsernamePasswordCredentials; 69 import org.apache.commons.httpclient.util.Base64; 70 import org.apache.commons.logging.Log; 71 import org.apache.commons.logging.LogFactory; 72 73 /*** 74 * <p> 75 * Basic authentication scheme as defined in RFC 2617. 76 * </p> 77 * 78 * @author <a href="mailto:remm@apache.org">Remy Maucherat</a> 79 * @author Rodney Waldhoff 80 * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a> 81 * @author Ortwin Gl�ck 82 * @author Sean C. Sullivan 83 * @author <a href="mailto:adrian@ephox.com">Adrian Sutton</a> 84 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> 85 * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a> 86 */ 87 88 public class BasicScheme extends RFC2617Scheme { 89 90 /*** Log object for this class. */ 91 private static final Log LOG = LogFactory.getLog(BasicScheme.class); 92 93 /*** 94 * Constructor for the basic authetication scheme. 95 * 96 * @param challenge authentication challenge 97 * 98 * @throws MalformedChallengeException is thrown if the authentication challenge 99 * is malformed 100 */ 101 public BasicScheme(final String challenge) throws MalformedChallengeException { 102 super(challenge); 103 } 104 105 106 /*** 107 * Returns textual designation of the basic authentication scheme. 108 * 109 * @return <code>basic</code> 110 */ 111 public String getSchemeName() { 112 return "basic"; 113 } 114 115 /*** 116 * Produces basic authorization string for the given set of 117 * {@link Credentials}. 118 * 119 * @param credentials The set of credentials to be used for athentication 120 * @param method Method name is ignored by the basic authentication scheme 121 * @param uri URI is ignored by the basic authentication scheme 122 * @throws AuthenticationException if authorization string cannot 123 * be generated due to an authentication failure 124 * 125 * @return a basic authorization string 126 */ 127 public String authenticate(Credentials credentials, String method, String uri) 128 throws AuthenticationException { 129 130 LOG.trace("enter BasicScheme.authenticate(Credentials, String, String)"); 131 132 UsernamePasswordCredentials usernamepassword = null; 133 try { 134 usernamepassword = (UsernamePasswordCredentials) credentials; 135 } catch (ClassCastException e) { 136 throw new AuthenticationException( 137 "Credentials cannot be used for basic authentication: " 138 + credentials.getClass().getName()); 139 } 140 return BasicScheme.authenticate(usernamepassword); 141 } 142 143 /*** 144 * Return a basic <tt>Authorization</tt> header value for the given 145 * {@link UsernamePasswordCredentials}. 146 * 147 * @param credentials The credentials to encode. 148 * 149 * @return a basic authorization string 150 */ 151 public static String authenticate(UsernamePasswordCredentials credentials) { 152 153 LOG.trace("enter BasicScheme.authenticate(UsernamePasswordCredentials)"); 154 155 if (credentials == null) { 156 throw new IllegalArgumentException("Credentials may not be null"); 157 } 158 StringBuffer buffer = new StringBuffer(); 159 buffer.append(credentials.getUserName()); 160 buffer.append(":"); 161 buffer.append(credentials.getPassword()); 162 163 return "Basic " + HttpConstants.getAsciiString( 164 Base64.encode(HttpConstants.getBytes(buffer.toString()))); 165 } 166 }

This page was automatically generated by Maven