Configuration de HTTPS/SSL dans JMap / Configuring HTTPS/SSL on JMap

Jump to English version

Il est très simple de configurer JMap pour utiliser des connexions HTTP encryptées (HTTPS/SSL).

Cette configuration nécessite un certificat compatible en format JKS ou PFX (PKCS12 keystore). Si vous ne possédez pas de certificat, il est possible de créer un certificat non-authentifié avec les outils du JDK ou OpenSSL.

Pour convertir un certificat RSA de format PEM en format JKS, veuillez utiliser la procédure décrite dans ce site : https://docs.oracle.com/cd/E35976_01/server.740/es_admin/src/tadm_ssl_convert_pem_to_jks.html

Pour faire la conversion d'un certificat du format PFX (PKCS12 keystores) au format JKS, utilisez la commande suivante (nécessite JDK 1.6+) : keytool -importkeystore -srckeystore mypfxfile.pfx -srcstoretype pkcs12 -destkeystore clientcert.jks -deststoretype JKS

Guide étape par étape

Création d'un certificat non authentifié (auto-signé)

Format JKS

Le programme keytool est situé dans le répertoire bin de votre JDK.  La commande à utiliser pour générer le certificat est :

keytool -genkey -keyalg RSA -keystore /chemin/vers/jmap/conf/certificat.keystore

(certificat.keystore est le nom du fichier qui sera régéné)

Lors de la création du certificat, le nom de domaine visé par HTTPS doit être entré dans: 'What is your first and last name?'.  Seule cette resource sera sécurisée et donc tout accès via un autre nom (ex: localhost, 127.0.0.1, etc.,) retournera une erreur de sécurité. 

Enter keystore password: javacaps
What is your first and last name?
[Unknown]: development.sun.com
What is the name of your organizational unit?
[Unknown]: Development
what is the name of your organization?
[Unknown]: Sun
What is the name of your City or Locality?
[Unknown]: Monrovia
What is the name of your State or Province?
[Unknown]: California
What is the two-letter country code for this unit?
[Unknown]: US
Is<CN=development.sun.com, OU=Development, O=Sun, L=Monrovia, ST=California, 
C=US> correct?
[no]: yes

Format PFX (PKCS12 keystore)

Installer OpenSSL

Créer le private key : openssl genrsa 2048 > private.pem

Créer le self signed certificate : openssl req -x509 -days 1000 -new -key private.pem -out public.pem

You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [AU]:
State or Province Name (full name) [Some-State]:
Locality Name (eg, city) []:
Organization Name (eg, company) [Internet Widgits Pty Ltd]:
Organizational Unit Name (eg, section) []:
Common Name (e.g. server FQDN or YOUR name) []:
Email Address []:

Créer le PFX : openssl pkcs12 -export -in public.pem -inkey private.pem -out mycert.pfx

Enter Export Password:
Verifying - Enter Export Password:

Configuration du certificat

Format JKS

1. Une fois le certificat créé, il faut changer les paramètres suivants dans  /chemin/vers/jmap/conf/jmapserver.properties 
   

   1. Le certificat créé :
      server.https.keystore.file=/chemin/vers/jmap/conf/certificat.keystore (Exemples : server.https.keystore.file=../conf/star_jmaponline_net.jks ou server.https.keystore.file=../conf/star_jmaponline_net.pfx)
      

   2. La valeur 'encrypted' indique si le mot de passe est encrypté, donc lorsque vous le configurez pour la première fois, vous devrez utiliser la fonction password(). Lorsque JMap Server sera démarré pour la première fois, votre mot de passe devrait être encrypté :
      server.https.keystore.password=password(put_your_keystore_password_here)
      server.https.keystore.password.encrypted=true
      

   3. Le port à utiliser pour HTTPS (443 par défaut) :
      server.https.port=443
      

2. Une fois ces étapes effectuées, redémarrez JMap Server et lancez JMap Admin en HTTPS:  https://xxx.xxx.xxx.xxx:443/jmapadmin.

Exemple de configuration format JKS

server.https.keystore.file=../conf/certificat.jks
server.https.keystore.password=password(votreMotDePasse)
server.https.keystore.password.encrypted=true
server.https.keystore.type=JKS
server.https.port=443
server.https.redirectEnabled=true

Exemple de configuration format PFX (PKCS12 keystore)

server.https.keystore.file=../conf/certificat.pfx
server.https.keystore.password=password(votreMotDePasse)
server.https.keystore.password.encrypted=true
server.https.keystore.type=PKCS12
server.https.port=443
server.https.redirectEnabled=true

L'option redirectEnabled forcera HTTPS en redirigeant automatiquement HTTP vers HTTPS si mise à 'true'.

L’option keystore.type doit être modifié en fonction du format

Si HTTPS ne répond pas, consultez les logs (jmap_log et le dernier fichier *.err ).  Il est possible que le certificat ne soit pas reconnu par Java et qu'il doit être ajouté au keystore:  https://k2geospatial.atlassian.net/wiki/x/AoA1Eg

English version

It is very simple to configure JMap to use HTTP encrypted connections (HTTPS / SSL).

This configuration requires a compatible JKS certificate. If you do not have a certificate, it is possible to create a non-authenticated certificate with JDK tools. To convert an existing PEM certificate into the JSK format, use the following procedure: https://docs.oracle.com/cd/E35976_01/server.740/es_admin/src/tadm_ssl_convert_pem_to_jks.html

Step-by-step guide

Creating a self-signed certificate

The keytool program can be found in the bin directory of your JDK.  The command for generate the certificate is:

keytool -genkey -keyalg RSA -keystore /chemin/vers/jmap/conf/certificat.keystore

When generating the certificate, the domain name must be entered as the answer to: 'What is your first and last name?'.  Only through this name will you be able to securely access JMap via HTTPS; any other URL (ex: localhost, 127.0.0.1, etc.) will return a security error.

Enter keystore password: javacaps
What is your first and last name?
[Unknown]: development.sun.com
What is the name of your organizational unit?
[Unknown]: Development
what is the name of your organization?
[Unknown]: Sun
What is the name of your City or Locality?
[Unknown]: Monrovia
What is the name of your State or Province?
[Unknown]: California
What is the two-letter country code for this unit?
[Unknown]: US
Is<CN=development.sun.com, OU=Development, O=Sun, L=Monrovia, ST=California, 
C=US> correct?
[no]: yes

Certificate configuration 

1. Once the certificate is done, you must change the following settings:
/chemin/vers/jmap/conf/jmapserver.properties 

a. The certificate created:
server.https.keystore.file=/chemin/vers/jmap/conf/certificat.keystore (Example : server.https.keystore.file=../conf/star_jmaponline_net.jks)

b. Your certificate password:
server.https.keystore.password=xxxxx

c. The value password.encrypted=false indicates if the password is encrypted.  So when you first configure the certificate, make sure that the encrypted value is set to false.  When JMap will start for the first time with the HTTPS configuration, it will encrypt the passwod and change the value to 'true'.  This value is not available in all JMap versions, if it is present in the configuration file, either ignore this step or upgrade to the latest JMap version.
server.https.keystore.password.encrypted=false

d.  The port to use for HTTPS (443 by default):
server.https.port=443

2. Once these steps donne, restart JMap Server and launch JMap Admin HTTPS:    https://xxx.xxx.xxx.xxx:443/jmapadmin

Example of configured file

server.https.client.auth=false
server.https.keystore.file=../conf/certificat.keystore
server.https.keystore.password=yourPassword
server.https.keystore.password.encrypted=false
server.https.keystore.type=JKS
server.https.port=443
server.https.redirectEnabled=true
server.https.scheme=https
server.https.ssl.protocol=TLS

The option redirectEnabled when set to true will force HTTPS by automatically redirect HTTP to HTTPS.

If an SSL error occurs when starting JMap server, it might be because the certificate is not recognized by Java.  Verify your jmap_log and latest .err and see this article https://k2geospatial.atlassian.net/wiki/x/AoA1Eg