org.hsqldb.rights.User Maven / Gradle / Ivy
Show all versions of hsqldb Show documentation
/* Copyright (c) 2001-2019, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.hsqldb.rights;
import org.hsqldb.HsqlNameManager.HsqlName;
import org.hsqldb.Tokens;
import org.hsqldb.error.Error;
import org.hsqldb.error.ErrorCode;
import org.hsqldb.lib.StringConverter;
/**
* A User Object extends Grantee with password for a
* particular database user.
*
* @author Campbell Burnet (campbell-burnet@users dot sourceforge.net)
* @author Fred Toussi (fredt@users dot sourceforge.net)
* @author Blaine Simpson (blaine dot simpson at admc dot com)
*
* @version 2.3.2
* @since 1.8.0
*/
public class User extends Grantee {
/** password. */
private String password;
public boolean isLocalOnly;
public boolean isExternalOnly;
/** default schema when new Sessions started (defaults to PUBLIC schema) */
private HsqlName initialSchema = null;
/**
* Constructor
*/
User(HsqlName name, GranteeManager manager) {
super(name, manager);
if (manager != null) {
updateAllRights();
}
}
public String getSQL() {
StringBuilder sb = new StringBuilder();
sb.append(Tokens.T_CREATE).append(' ').append(Tokens.T_USER);
sb.append(' ').append(granteeName.statementName).append(' ');
sb.append(Tokens.T_PASSWORD).append(' ').append(Tokens.T_DIGEST);
sb.append(' ').append('\'').append(password).append('\'');
return sb.toString();
}
public String getPasswordDigest() {
return password;
}
public void setPassword(String password, boolean isDigest) {
if (!isDigest) {
password = granteeManager.digest(password);
}
this.password = password;
}
/**
* Checks if this object's password attribute equals
* specified argument, else throws.
*/
public void checkPassword(String value) {
String digest = granteeManager.digest(value);
if (!digest.equals(password)) {
throw Error.error(ErrorCode.X_28000, granteeName.statementName);
}
}
/**
* Returns the initial schema for the user
*/
public HsqlName getInitialSchema() {
return initialSchema;
}
public HsqlName getInitialOrDefaultSchema() {
if (initialSchema != null) {
return initialSchema;
}
HsqlName schema =
granteeManager.database.schemaManager.findSchemaHsqlName(
getName().getNameString());
if (schema == null) {
return granteeManager.database.schemaManager
.getDefaultSchemaHsqlName();
} else {
return schema;
}
}
/**
* This class does not have access to the SchemaManager, therefore
* caller should verify that the given schemaName exists.
*
* @param schema An existing schema. Null value allowed,
* which means use the DB default session schema.
*/
public void setInitialSchema(HsqlName schema) {
initialSchema = schema;
}
public String getInitialSchemaSQL() {
StringBuilder sb = new StringBuilder();
sb.append(Tokens.T_ALTER).append(' ');
sb.append(Tokens.T_USER).append(' ');
sb.append(getName().getStatementName()).append(' ');
sb.append(Tokens.T_SET).append(' ');
sb.append(Tokens.T_INITIAL).append(' ');
sb.append(Tokens.T_SCHEMA).append(' ');
sb.append(initialSchema.getStatementName());
return sb.toString();
}
/**
* Returns the DDL string for local authentication.
*
*/
public String getLocalUserSQL() {
StringBuilder sb = new StringBuilder(64);
sb.append(Tokens.T_ALTER).append(' ');
sb.append(Tokens.T_USER).append(' ');
sb.append(getName().getStatementName()).append(' ');
sb.append(Tokens.T_SET).append(' ').append(Tokens.T_LOCAL);
sb.append(' ').append(Tokens.T_TRUE);
return sb.toString();
}
/**
* Returns the SQL string for setting password digest.
*
*/
public String getSetUserPasswordDigestSQL(String password,
boolean isDigest) {
if (!isDigest) {
password = granteeManager.digest(password);
}
StringBuilder sb = new StringBuilder(64);
sb.append(Tokens.T_ALTER).append(' ');
sb.append(Tokens.T_USER).append(' ');
sb.append(getName().getStatementName()).append(' ');
sb.append(Tokens.T_SET).append(' ');
sb.append(Tokens.T_PASSWORD).append(' ').append(Tokens.T_DIGEST);
sb.append(' ').append('\'').append(password).append('\'');
return sb.toString();
}
/**
* Returns the SQL string for setting password digest.
*
*/
public static String getSetCurrentPasswordDigestSQL(GranteeManager manager,
String password, boolean isDigest) {
if (!isDigest) {
password = manager.digest(password);
}
StringBuilder sb = new StringBuilder(64);
sb.append(Tokens.T_SET).append(' ');
sb.append(Tokens.T_PASSWORD).append(' ').append(Tokens.T_DIGEST);
sb.append(' ').append('\'').append(password).append('\'');
return sb.toString();
}
/**
* Retrieves the redo log character sequence for connecting
* this user
*
* @return the redo log character sequence for connecting
* this user
*/
public String getConnectUserSQL() {
StringBuilder sb = new StringBuilder();
sb.append(Tokens.T_SET).append(' ');
sb.append(Tokens.T_SESSION).append(' ');
sb.append(Tokens.T_AUTHORIZATION).append(' ');
sb.append(StringConverter.toQuotedString(getName().getNameString(),
'\'', true));
return sb.toString();
}
}