kirillius
/
mikrotik-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'tls' of github.com:GideonLeGrange/mikrotik-java into tls

This commit is contained in:
Gideon le Grange 2016-02-02 22:15:45 +02:00
parent 9f531220bf b23bcdbf4a
commit 8882226684
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -14,12 +14,15 @@ This library uses [semantic versioning](http://semver.org/)
Version 3.0 addresses the problems the API has around TLS encryption. To do this, the way secure connections are implemented is changed, to put the power to do this in the hands of the user. This means that: Version 3.0 addresses the problems the API has around TLS encryption. To do this, the way secure connections are implemented is changed, to put the power to do this in the hands of the user. This means that:
* The `connectTLS` API methods were removed. * The `connectTLS` API methods were removed.
* A new method, `connect(SocketFactory fact, String host, int port, int timeout)`, was added. * A new method, `connect(SocketFactory fact, String host, int port, int timeout)`, was added to allow for better user control over sockets and especially encrypyion.
Further changes include: Further changes include:
* The deprecated `disconnect()` method is removed. * The deprecated `disconnect()` method is removed.
#### Version 2.x #### Version 2.x
Version 2.2 is the last version 2.x release and will be supported for a limited time.
* 2.2 implemented AutoCloseable on ApiConnection to support Java 7's try-with-resources statement. * 2.2 implemented AutoCloseable on ApiConnection to support Java 7's try-with-resources statement.
* 2.1 added the ability to use connection and command timeouts as. * 2.1 added the ability to use connection and command timeouts as.
@ -47,7 +50,8 @@ You can also clone or fork the repository, or download the source as a zip or ta
## Contributing ## Contributing
I welcome contributions, be it bug fixes or other improvements. If you fix or change something, please submit a pull request. If you want to report a bug, please open an issue. I welcome contributions, be it bug fixes or other improvements. If you fix or change something, please submit a pull request. If you want to report a bug, please open an issue. General questions
are also welcome.
# Examples # Examples
@ -62,18 +66,17 @@ con.login("admin","password"); // log in to router
con.execute("/system/reboot"); // execute a command con.execute("/system/reboot"); // execute a command
con.disconnect(); // disconnect from router con.disconnect(); // disconnect from router
``` ```
If your router does not use the default API port, the port can be specified when connecting:
```java
ApiConnection con = ApiConnection.connect("10.0.1.1", 1337); // connect to router on port 1337
```
To open an encrypted (TLS) connection is as simple, assuming the default API-SSL port is used: To encrypt API traffic (recommended) you need to open a TLS connection to the router. This is done by passing an instance of the `SocketFactory` you wish to use to construct the
TLS socket to the API:
```java ```java
ApiConnection con = ApiConnection.connectTLS("10.0.1.1"); // connect to router using TLS ApiConnection con = ApiConnection.connect(SSLSocketFactory.getDefault(), Config.HOST, ApiConnection.DEFAULT_TLS_PORT, ApiConnection.DEFAULT_CONNECTION_TIMEOUT);
``` ```
Besides allowing the user to specify the socket factory, it also gives full control over the TCP Port and connection timeout.
### Connection timeouts ### Connection timeouts
By default, the API will generate an exception if it cannot connect to the specified router. This can take place immediately (typically if the router returns a 'Connection refused' error), but can also take up to 60 seconds if the router host is firewalled or if there are other network problems. This 60 seconds is the 'default connection timeout' an can be overridded by passing the preferred timeout to the APi as last parameter in a ```connect()``` or ```connectTLS()``` call. Here is the non-TLS example: By default, the API will generate an exception if it cannot connect to the specified router. This can take place immediately (typically if the router returns a 'Connection refused' error), but can also take up to 60 seconds if the router host is firewalled or if there are other network problems. This 60 seconds is the 'default connection timeout' an can be overridded by passing the preferred timeout to the APi as last parameter in a ```connect()``` or ```connectTLS()``` call. Here is the non-TLS example: