org.openstreetmap.josm.io.remotecontrol

Class RemoteControlHttpsServer

java.lang.Object

java.lang.Thread

org.openstreetmap.josm.io.remotecontrol.RemoteControlHttpsServer

All Implemented Interfaces:

java.lang.Runnable

public class RemoteControlHttpsServer
extends java.lang.Thread

Simple HTTPS server that spawns a RequestProcessor for every secure connection.

Since:

6941

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENTRY_ALIAS Unique alias used to store JOSM localhost entry, both in JOSM keystore and system/browser keystores.
private static int	HTTPS_PORT
private static RemoteControlHttpsServer	instance4 The server instance for IPv4
private static RemoteControlHttpsServer	instance6 The server instance for IPv6
static StringProperty	KEYENTRY_PASSWORD Preference for certificate password (automatically generated by JOSM).
static java.lang.String	KEYSTORE_FILENAME JOSM keystore file name.
static StringProperty	KEYSTORE_PASSWORD Preference for keystore password (automatically generated by JOSM).
private java.net.ServerSocket	server The server socket
private javax.net.ssl.SSLContext	sslContext SSL context information for connections

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
RemoteControlHttpsServer(int port, boolean ipv6) Constructs a new RemoteControlHttpsServer.

Method Summary

Modifier and Type	Method and Description
private static sun.security.x509.GeneralNameInterface	createGeneralNameInterface(java.lang.String t, java.lang.String v) Creates a GeneralNameInterface object from known types.
private static java.security.cert.X509Certificate	generateCertificate(java.lang.String dn, java.security.KeyPair pair, int days, java.lang.String algorithm, java.lang.String san) Create a self-signed X.509 Certificate.
private void	initialize() Initializes the TLS basics.
static java.security.KeyStore	loadJosmKeystore() Loads the JOSM keystore.
static void	restartRemoteControlHttpsServer() Starts or restarts the HTTPS server
void	run() The main loop, spawns a RequestProcessor for each connection.
static java.nio.file.Path	setupJosmKeystore() Setup the JOSM internal keystore, used to store HTTPS certificate and private key.
static boolean	setupPlatform(java.security.KeyStore josmKs) Setup the platform-dependant certificate stuff.
static void	stopRemoteControlHttpsServer() Stops the HTTPS server
void	stopServer() Stops the HTTPS server.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

server

private final java.net.ServerSocket server

The server socket

instance4

private static volatile RemoteControlHttpsServer instance4

The server instance for IPv4

instance6

private static volatile RemoteControlHttpsServer instance6

The server instance for IPv6

sslContext

private javax.net.ssl.SSLContext sslContext

SSL context information for connections

HTTPS_PORT

private static final int HTTPS_PORT

See Also:

Constant Field Values

KEYSTORE_FILENAME

public static final java.lang.String KEYSTORE_FILENAME

JOSM keystore file name.

Since:

7337

See Also:

Constant Field Values

KEYSTORE_PASSWORD

public static final StringProperty KEYSTORE_PASSWORD

Preference for keystore password (automatically generated by JOSM).

Since:

7335

KEYENTRY_PASSWORD

public static final StringProperty KEYENTRY_PASSWORD

Preference for certificate password (automatically generated by JOSM).

Since:

7335

ENTRY_ALIAS

public static final java.lang.String ENTRY_ALIAS

Unique alias used to store JOSM localhost entry, both in JOSM keystore and system/browser keystores.

Since:

7343

See Also:

Constant Field Values

Constructor Detail

RemoteControlHttpsServer

public RemoteControlHttpsServer(int port,
                                boolean ipv6)
                         throws java.io.IOException,
                                java.security.GeneralSecurityException

Constructs a new RemoteControlHttpsServer.

Parameters:

port - The port this server will listen on

ipv6 - Whether IPv6 or IPv4 server should be started

Throws:

java.io.IOException - when connection errors

java.security.GeneralSecurityException - in case of SSL setup errors

Since:

8339

Method Detail

createGeneralNameInterface

private static sun.security.x509.GeneralNameInterface createGeneralNameInterface(java.lang.String t,
                                                                                 java.lang.String v)
                                                                          throws java.io.IOException

Creates a GeneralNameInterface object from known types.

Parameters:

t - one of 4 known types

v - value

Returns:

which one

Throws:

java.io.IOException - if any I/O error occurs

generateCertificate

private static java.security.cert.X509Certificate generateCertificate(java.lang.String dn,
                                                                      java.security.KeyPair pair,
                                                                      int days,
                                                                      java.lang.String algorithm,
                                                                      java.lang.String san)
                                                               throws java.security.GeneralSecurityException,
                                                                      java.io.IOException

Create a self-signed X.509 Certificate.

Parameters:

dn - the X.509 Distinguished Name, eg "CN=localhost, OU=JOSM, O=OpenStreetMap"

pair - the KeyPair

days - how many days from now the Certificate is valid for

algorithm - the signing algorithm, eg "SHA256withRSA"

san - SubjectAlternativeName extension (optional)

Returns:

the self-signed X.509 Certificate

Throws:

java.security.GeneralSecurityException - if any security error occurs

java.io.IOException - if any I/O error occurs

setupJosmKeystore

public static java.nio.file.Path setupJosmKeystore()
                                            throws java.io.IOException,
                                                   java.security.GeneralSecurityException

Setup the JOSM internal keystore, used to store HTTPS certificate and private key.

Returns:

Path to the (initialized) JOSM keystore

Throws:

java.io.IOException - if an I/O error occurs

java.security.GeneralSecurityException - if a security error occurs

Since:

7343

loadJosmKeystore

public static java.security.KeyStore loadJosmKeystore()
                                               throws java.io.IOException,
                                                      java.security.GeneralSecurityException

Loads the JOSM keystore.

Returns:

the (initialized) JOSM keystore

Throws:

java.io.IOException - if an I/O error occurs

java.security.GeneralSecurityException - if a security error occurs

Since:

7343

initialize

private void initialize()
                 throws java.io.IOException,
                        java.security.GeneralSecurityException

Initializes the TLS basics.

Throws:

java.io.IOException - if an I/O error occurs

java.security.GeneralSecurityException - if a security error occurs

setupPlatform

public static boolean setupPlatform(java.security.KeyStore josmKs)
                             throws java.security.KeyStoreException,
                                    java.security.NoSuchAlgorithmException,
                                    java.security.cert.CertificateException,
                                    java.io.IOException

Setup the platform-dependant certificate stuff.

Parameters:

josmKs - The JOSM keystore, containing localhost certificate and private key.

Returns:

true if something has changed as a result of the call (certificate installation, etc.)

Throws:

java.security.KeyStoreException - if the keystore has not been initialized (loaded)

java.security.NoSuchAlgorithmException - in case of error

java.security.cert.CertificateException - in case of error

java.io.IOException - in case of error

Since:

7343

restartRemoteControlHttpsServer

public static void restartRemoteControlHttpsServer()

Starts or restarts the HTTPS server

stopRemoteControlHttpsServer

public static void stopRemoteControlHttpsServer()

Stops the HTTPS server

run

public void run()

The main loop, spawns a RequestProcessor for each connection.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

stopServer

public void stopServer()
                throws java.io.IOException

Stops the HTTPS server.

Throws:

java.io.IOException - if any I/O error occurs