Installation
Sur cette page
Ce tutoriel décrit comment installer manuellement un serveur TOSIAM directement à partir des assets livrés dans une release (archive .war + outils SSOAdminTools / SSOConfiguratorTools), sans passer par tosiam-project-generator-maven-plugin ni par le QuickStart packagé. C’est la méthode utile pour comprendre ce que ces outils font sous le capot, pour déployer TOSIAM sur un Tomcat déjà en place, ou pour intégrer son installation dans un script de provisioning maison.
Public concerné#
- Développeur créant un module ou un graphe d’authentification personnalisé.
- Intégrateur souhaitant simuler une brique IAM au sein d’une application plus large, sans passer par un environnement de production complet.
Prérequis#
- JDK 17 ou 21 (la variable d’environnement
JAVA_HOMEdoit être définie). - Apache Tomcat 11.0.14 (nous noterons
<TOMCAT>son répertoire d’installation) : c’est la version de Tomcat utilisée par le QuickStart officiel de TOSIAM 3.38.0. - Espace disque libre sur le système de fichiers du répertoire de configuration de TOSIAM (
BASE_DIR) :- jusqu’à la 3.37.0 : au moins 5 Gio. En dessous, la base du serveur d’annuaire embarqué refuse les écritures et l’installation échoue avec l’erreur
Error Importing LDIF File; - à partir de la 3.38.0 : au moins 1 Gio. En dessous, seuls les comptes qui ont le privilège
BYPASS_LOCKDOWNpeuvent encore modifier les données ; sous 500 Mio, plus aucune modification n’est acceptée.
- jusqu’à la 3.37.0 : au moins 5 Gio. En dessous, la base du serveur d’annuaire embarqué refuse les écritures et l’installation échoue avec l’erreur
Étape 1 : télécharger les assets#
Téléchargez TosiAM-3.38.0.zip depuis la page Téléchargement (ou directement depuis les releases GitHub).
Cette archive contient trois fichiers, que vous devez extraire :
TosiAM-3.38.0.war: le serveur TOSIAM lui-même.SSOAdminTools-3.38.0.zip: l’outil en ligne de commandessoadm.SSOConfiguratorTools-3.38.0.zip: l’outil de configuration automatisée.
Étape 2 : déployer le WAR et démarrer Tomcat#
Nous supposons que Tomcat est arrêté.
- Copiez le fichier
TosiAM-3.38.0.wardans le répertoire<TOMCAT>/webapps, et renommez l’archive entosiam.war. - Ouvrez une fenêtre console :
export CATALINA_HOME=<TOMCAT>
export CATALINA_OPTS="-Xmx2g -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=256m \
-Dcom.sun.identity.configuration.directory=<INSTANCE>"
CATALINA_OPTS="${CATALINA_OPTS} --add-exports java.base/sun.misc=ALL-UNNAMED \
--add-exports java.base/sun.security.provider=ALL-UNNAMED \
--add-exports java.base/sun.security.x509=ALL-UNNAMED \
--add-exports java.base/sun.security.util=ALL-UNNAMED \
--add-exports java.base/sun.security.tools.keytool=ALL-UNNAMED \
--add-exports java.xml/com.sun.org.apache.xerces.internal.dom=ALL-UNNAMED"
$CATALINA_HOME/bin/catalina.sh run@echo off
set CATALINA_HOME=<TOMCAT>
set CATALINA_OPTS=-Xmx2g -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=256m -Dcom.sun.identity.configuration.directory=<INSTANCE>
set CATALINA_OPTS=%CATALINA_OPTS% --add-exports java.base/sun.misc=ALL-UNNAMED --add-exports java.base/sun.security.provider=ALL-UNNAMED --add-exports java.base/sun.security.x509=ALL-UNNAMED --add-exports java.base/sun.security.util=ALL-UNNAMED --add-exports java.base/sun.security.tools.keytool=ALL-UNNAMED --add-exports java.xml/com.sun.org.apache.xerces.internal.dom=ALL-UNNAMED
call "%CATALINA_HOME%\bin\catalina.bat" runAprès quelques secondes, on obtient les traces suivantes :
05-Dec-2023 11:04:16.655 INFOS [main] org.apache.coyote.AbstractProtocol.start Démarrage du gestionnaire de protocole ["http-nio-8080"]
05-Dec-2023 11:04:16.662 INFOS [main] org.apache.catalina.startup.Catalina.start Le démarrage du serveur a pris [5056] millisecondesOuvrez un navigateur, et accédez à http://localhost:8080/tosiam. Tant qu’il n’est pas installé, le serveur n’affiche que son assistant d’installation, dans la langue du navigateur.
Étape 3 : création/configuration de l’instance, mode manuel#
- Prouvez que vous avez accès au serveur. Personne n’a encore de compte : au démarrage, le serveur a écrit un jeton à usage unique dans le fichier
.tosiam-setup-tokendu répertoire personnel du compte qui exécute Tomcat. Lisez-le sous ce compte (cat ~/.tosiam-setup-token), collez-le dans le champ « Jeton d’installation », puis cliquez sur « Vérifier ». Un jeton refusé est signalé sous le champ.
- Choisissez l’installation. « Par défaut » ne demande que le mot de passe de l’administrateur : elle convient à une évaluation. « Personnalisée » fait choisir chaque réglage (serveur, annuaires de configuration et d’utilisateurs, site) ; c’est celle d’une production. Ce tutoriel suit l’installation par défaut. Cliquez sur « Continuer ».
- Acceptez la licence. Cochez « J’accepte le contrat de licence » et cliquez sur « Continuer ». Le volet de gauche montre tout le parcours et l’étape en cours.
- Choisissez le mot de passe de
amAdmin(8 à 24 caractères), l’administrateur par défaut de TOSIAM, puis cliquez sur « Installer TOSIAM ». « Quels sont les réglages par défaut » montre ce que le serveur va utiliser.
L’installation démarre. Ses étapes s’affichent au fil du journal du serveur, avec le temps écoulé ; « Journal » déplie le journal complet. Gardez la page ouverte : elle ne peut pas reprendre le suivi d’une installation en cours.
Si tout s’est bien passé, la fin de l’installation s’affiche comme suit, avec l’adresse du serveur et l’emplacement du journal :
Le journal est aussi écrit dans le fichier <INSTANCE>/install.log. Si l’installation échoue, la page le dit, garde le journal ouvert et propose « Revenir aux paramètres » : ce qui a été saisi est conservé.
Cliquez sur « Aller à la connexion » et connectez-vous avec amAdmin : vous arrivez dans la console TOSIAM.
Étape 4 : création/configuration de l’instance, mode automatique (optionnel)#
Nous allons maintenant installer un outil permettant d’automatiser l’étape précédente.
Créez un répertoire que nous noterons <TOOLS>, et dans ce répertoire, créez un répertoire config. Dézippez le contenu du fichier SSOConfiguratorTools-3.38.0.zip récupéré à l’étape 1 dans config.
Dans le répertoire config, créez le fichier de configuration suivant, config.properties :
SERVER_URL=http://localhost:8080
DEPLOYMENT_URI=/tosiam
BASE_DIR=<INSTANCE>
locale=en_US
PLATFORM_LOCALE=en_US
AM_ENC_KEY=mykey
ADMIN_PWD=password
COOKIE_DOMAIN=localhost
ACCEPT_LICENSES=true
DATA_STORE=embedded
DIRECTORY_SSL=SIMPLE
DIRECTORY_SERVER=localhost
DIRECTORY_PORT=50389
DIRECTORY_ADMIN_PORT=4444
DIRECTORY_JMX_PORT=1389
ROOT_SUFFIX=dc=example,dc=com
DS_DIRMGRDN=cn=Directory Manager
DS_DIRMGRPASSWD=secret12Si vous avez exécuté l’étape 3 (mode manuel), arrêtez le serveur Tomcat et supprimez le répertoire <INSTANCE>.
Relancez le serveur Tomcat comme décrit à l’étape 2.
Dans le répertoire <TOOLS>/config, ouvrez une fenêtre console, et tapez :
${JAVA_HOME}/bin/java -jar <TOOLS>/config/tosiam-configurator-tool-3.38.0.jar -f config.properties@echo off
"%JAVA_HOME%\bin\java" -jar "%TOOLS%\config\tosiam-configurator-tool-3.38.0.jar" -f "config.properties"Les informations affichées dans la console sont également disponibles dans le fichier <INSTANCE>/install.log.
Si tout s’est bien passé, vous pouvez maintenant vous connecter à la console TOSIAM (http://localhost:8080/tosiam).
Étape 5 : installation de ssoadm (optionnel)#
ssoadm est l’outil en ligne de commande pour configurer une instance TOSIAM. Il permet en particulier d’automatiser toutes les actions réalisées dans la console TOSIAM. C’est l’outil qu’utilise en interne le goal ssoadm de tosiam-project-generator-maven-plugin (voir Générer un projet avec Maven).
Créez un répertoire que nous noterons <TOOLS>, et dans ce répertoire, créez un répertoire admin. Dézippez le contenu du fichier SSOAdminTools-3.38.0.zip récupéré à l’étape 1 dans admin.
Dans le répertoire admin, créez un fichier .pwd.txt contenant le mot de passe du compte amadmin, et lancez le script d’installation :
echo password > .pwd.txt && chmod 400 .pwd.txt
./setup --acceptLicense -p <INSTANCE>@echo off
echo password > .pwd.txt
setup --acceptLicense -p <INSTANCE>Si tout s’est bien passé, vous devriez avoir quelque chose comme :
La version de ce tools.zip est : TOSIAM 3.38.0
La version de votre instance de serveur est : 3.38.0
Mis à jour le