From d3269dba90a0f9ddb474a484b5a5c24209acc2f2 Mon Sep 17 00:00:00 2001 From: ulrich@undisclosed <ulrich@ulrich-vaio> Date: Wed, 26 Feb 2020 16:50:42 +0000 Subject: [PATCH] Doku aktualisiert --- src/java/de/uhilger/um/api/UserMgr.java | 159 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 files changed, 145 insertions(+), 14 deletions(-) diff --git a/src/java/de/uhilger/um/api/UserMgr.java b/src/java/de/uhilger/um/api/UserMgr.java index 3ae67bf..7775e38 100644 --- a/src/java/de/uhilger/um/api/UserMgr.java +++ b/src/java/de/uhilger/um/api/UserMgr.java @@ -1,31 +1,162 @@ +/* + * Nutzerverwaltung - User and role management in your browser + * Copyright (C) 2011-2017 Ulrich Hilger, http://uhilger.de + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see http://www.gnu.org/licenses/ + */ + package de.uhilger.um.api; -import de.uhilger.baselink.GenericRecord; -import de.uhilger.baselink.Record; -import de.uhilger.um.App; +import de.uhilger.baselink.PersistenceManager; +import de.uhilger.um.Digester; import de.uhilger.um.daten.User; -import org.apache.catalina.realm.RealmBase; +import de.uhilger.um.daten.UserRole; +import java.sql.Connection; +import java.util.List; +import java.util.logging.Logger; /** + * <p>Die Methoden der Klasse UserMgr sind + * die 'Fassade', die über Transit als Programmschnittstelle + * (Application Programming Interface, API) + * nach außen bereitgestellt wird. UserMgr dient weitgehend + * als 'Durchreiche' für die Funktionalität anderer Klassen.</p> + * + * <p> + * Der UserMgr erhält die benötigten Methoden aus dem ServletContext. + * Auf diese Weise sind keine statischen Abhängigkeiten in den Code + * gewandert. Die folgenden Elemente werden vom UserMgr im ServletContext + * erwartet: + * <ul> + * <li>PersistenceManager</li> + * <li>SQL-Properties</li> + * <li>Digester</li> + * </p> + * + * @author Copyright (c) Ulrich Hilger, http://uhilger.de + * @author Published under the terms and conditions of the + * <a href="http://www.gnu.org/licenses/agpl-3.0" target="_blank">GNU Affero + * General Public License</a> * - * @author Ulrich Hilger + * @version 2, December 27, 2016 */ -public class UserMgr { +public class UserMgr extends Api /*implements WebKontext, RequestKontext*/ { - private static final String MD5 = "MD5"; + private static final Logger logger = Logger.getLogger(UserMgr.class.getName()); - private static final Record UserMapper = new GenericRecord(User.class); + /** Name, unter dem das Properties-Objekt mit den SQL-Befehlen im ServletContext hinterlegt ist */ + public static final String UM_SQL_PROPERTIES = "umSqlProperties"; + + /** Name, unter dem das Digester-Objekt im ServletContext hinterlegt ist */ + public static final String P_DIGESTER = "digester"; + + /** Name, unter dem das Zugriffsobjekt zur Datenbank im ServletContext hinterlegt ist */ + public static final String UM_DB = "umDb"; - public User createUser(User user) { + /** Boolean-Konstante zur Kennzeichnung von Datenbankergebnissen ohne Blobs */ + public static final boolean WITHOUT_BLOBS = false; + + /** Referenz zum SQL-Befehl zur Ermittlung der Benutzer */ + public static final String SQL_GET_USER_LIST = "getUserList"; + /** Referenz zum SQL-Befehl zur Ermittlung der Benutzer-Namen */ + public static final String SQL_GET_USER_NAME_LIST = "getUserNameList"; + /** Referenz zum SQL-Befehl zur Ermittlung der Rollen */ + public static final String SQL_GET_ROLE_LIST = "getRoleList"; + /** Referenz zum SQL-Befehl zur Ermittlung der Rollen eines Benutzers */ + public static final String SQL_GET_USER_ROLES = "getUserRoles"; + /** Referenz zum SQL-Befehl zum Loeschen aller Rollen eines Nutzers */ + public static final String SQL_DELETE_USER_ROLES = "deleteUserRoles"; + public static final String SQL_GET_USER_DATA = "getUserData"; + + public static final String MP_USER = "userMapper"; + public static final String MP_USER_DATA = "userDataMapper"; + public static final String MP_USER_ROLE = "userRoleMapper"; + + /* ----------- Benutzer -------------- */ + + public User createUser(User user) throws ClassNotFoundException, InstantiationException, IllegalAccessException { + + /* + Irgendetwas wurde am Tomcat-Mechanismus fuer verschluesslete Kennworte + geaendert. Es muss ein eigener Mechanismus implementiert werden. + Bis da hin wird das Kennwort im Klartext in der Datenbank gespeichert. + */ + + + String kw = user.getPw(); - String digestedPw = RealmBase.Digest(kw, MD5, null); + String digesterClassName = getServletContext().getInitParameter(P_DIGESTER); + Digester digester = (Digester) Class.forName(digesterClassName).newInstance(); + + /* + MD5 geht nicht mehr, + vgl. http://stackoverflow.com/questions/39967289/how-to-use-digest-authentication-in-tomcat-8-5 + */ + + String digestedPw = digester.digest(kw, Digester.SHA256, null); user.setPw(digestedPw); - App.getDatabase().insert(user, UserMapper); + + getDb().insert(user, getMapper(MP_USER)); return user; } - public String hallo() { - return "Hallo Welt"; + public List getUserNameList() { + return removeHeadline(getDb().select(getSql(SQL_GET_USER_NAME_LIST), WITHOUT_BLOBS)); } -} + public User deleteUser(User user) { + PersistenceManager pm = getDb(); + Connection c = pm.getConnection(); + pm.startTransaction(c); + pm.execute(c, getSql(SQL_DELETE_USER_ROLES), user.getId()); + User deletedUser = (User) pm.delete(c, user, getMapper(MP_USER)); + pm.commit(c); + return deletedUser; + } + + public String logout() { + getRequest().getSession().invalidate(); + return "logged out"; + } + + /* ------------ Rollen ------------------ */ + + public UserRole grantRole(UserRole role) { + getDb().insert(role, getMapper(MP_USER_ROLE)); + return role; + } + + public UserRole revokeRole(UserRole role) { + getDb().delete(role, getMapper(MP_USER_ROLE)); + return role; + } + + public List getRoleNamesGranted() { + return removeHeadline(getDb().select(getSql(SQL_GET_ROLE_LIST), WITHOUT_BLOBS)); + } + + public List getUserRoleNames(String userId) { + return removeHeadline(getDb().select(getSql(SQL_GET_USER_ROLES), WITHOUT_BLOBS, userId)); + } + + /* ----------- Helfer ---- */ + + private List removeHeadline(List list) { + if(list != null && list.size() > 0) { + list.remove(0); + } + return list; + } + +} \ No newline at end of file -- Gitblit v1.9.3