View Javadoc

1   /*
2    * Copyright (c) 2006 The University of Reading
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    * 1. Redistributions of source code must retain the above copyright
9    *    notice, this list of conditions and the following disclaimer.
10   * 2. Redistributions in binary form must reproduce the above copyright
11   *    notice, this list of conditions and the following disclaimer in the
12   *    documentation and/or other materials provided with the distribution.
13   * 3. Neither the name of the University of Reading, nor the names of the
14   *    authors or contributors may be used to endorse or promote products
15   *    derived from this software without specific prior written permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20   * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21   * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   */
28  
29  package uk.ac.rdg.resc.jstyx.server;
30  
31  import uk.ac.rdg.resc.jstyx.StyxException;
32  
33  /***
34   * StyxFile that is used to exchange authentication information.  Clients must
35   * write their password into this file.
36   *
37   * @author Jon Blower
38   * $Revision: 601 $
39   * $Date: 2006-03-20 17:51:50 +0000 (Mon, 20 Mar 2006) $
40   * $Log$
41   * Revision 1.1  2006/03/20 17:51:50  jonblower
42   * Adding authentication to base JStyx system
43   *
44   */
45  public class AuthFile extends InMemoryFile
46  {
47      private StyxSecurityContext securityContext;
48      private User user;
49      
50      /***
51       * Creates a new instance of AuthFile
52       * @param securityContext The security context for this connection
53       * @param username The name of the user (as claimed by the user)
54       * @throws StyxSecurityException if the user could not be identified or 
55       * if there was an error reading from the security context information
56       */
57      public AuthFile(StyxSecurityContext securityContext, String username)
58          throws StyxException
59      {
60          super("auth", "nobody", "nobody", 0666, false, false);
61          this.auth = true;
62          this.securityContext = securityContext;
63          this.user = this.securityContext.getUser(username);
64      }
65      
66      /***
67       * @return true if the user with the given name has successfully authenticated
68       */
69      public boolean isAuthenticated(String username)
70      {
71          if (this.user.getUsername().trim().equals(username) &&
72              this.user.passwordMatches(this.getContents()))
73          {
74              return true;
75          }
76          return false;
77      }
78      
79      /***
80       * @return the User that this AuthFile belongs to
81       */
82      public User getUser()
83      {
84          return this.user;
85      }
86      
87  }