|
|
@@ -1,16 +1,12 @@
|
|
|
-[](https://sonarcloud.io/summary/new_code?id=EIPStackGroup_OpENer)
|
|
|
-[](https://gitter.im/EIPStackGroupOpENer/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
-
|
|
|
-
|
|
|
OpENer Version 2.3.0
|
|
|
====================
|
|
|
|
|
|
Welcome to OpENer!
|
|
|
------------------
|
|
|
|
|
|
-OpENer is an EtherNet/IP™ stack for I/O adapter devices; supports multiple
|
|
|
+OpENer is an EtherNet/IP™ stack for I/O adapter devices; supports multiple
|
|
|
I/O and explicit connections; includes objects and services to make EtherNet/IP™-
|
|
|
-compliant products defined in THE ETHERNET/IP SPECIFICATION and published by
|
|
|
+compliant products defined in THE ETHERNET/IP SPECIFICATION and published by
|
|
|
ODVA (http://www.odva.org).
|
|
|
|
|
|
Participate!
|
|
|
@@ -24,8 +20,8 @@ Users mailing list: https://groups.google.com/forum/#!forum/eip-stack-group-open
|
|
|
Requirements:
|
|
|
-------------
|
|
|
OpENer has been developed to be highly portable. The default version targets PCs
|
|
|
-with a POSIX operating system and a BSD-socket network interface. To test this
|
|
|
-version we recommend a Linux PC or Windows with Cygwin (http://www.cygwin.com)
|
|
|
+with a POSIX operating system and a BSD-socket network interface. To test this
|
|
|
+version we recommend a Linux PC or Windows with Cygwin (http://www.cygwin.com)
|
|
|
installed. You will need to have the following installed:
|
|
|
|
|
|
* CMake
|
|
|
@@ -33,14 +29,14 @@ installed. You will need to have the following installed:
|
|
|
* make
|
|
|
* binutils
|
|
|
* the development library of libcap (libcap-dev or equivalient)
|
|
|
-
|
|
|
+
|
|
|
for normal building. These should be installed on most Linux installations and
|
|
|
are part of the development packages of Cygwin.
|
|
|
|
|
|
If you want to run the unit tests you will also have to download CppUTest via
|
|
|
https://github.com/cpputest/cpputest
|
|
|
|
|
|
-For configuring the project we recommend the use of a CMake GUI (e.g., the
|
|
|
+For configuring the project we recommend the use of a CMake GUI (e.g., the
|
|
|
cmake-gui package on Linux, or the Installer for Windows available at [CMake](https://cmake.org/))
|
|
|
|
|
|
Compile for Linux/POSIX:
|
|
|
@@ -78,7 +74,7 @@ Compile for Windows XP/7/8 via Visual Studio:
|
|
|
e.g. ``OpENer 3``
|
|
|
|
|
|
In order to get the correct interface index enter the command ``route print`` in a command promt and search for the MAC address of your chosen network interface at the beginning of the output. The leftmost number is the corresponding interface index.
|
|
|
-
|
|
|
+
|
|
|
Compile for Windows XP/7/8/10 via Cygwin:
|
|
|
--------------------------------------
|
|
|
The POSIX setup file can be reused for Cygwin. Please note, that you cannot use RT mode and you will have to remove the code responsible for checking and getting the needed capabilities, as libcap is not available in Cygwin. The easier and more supported way to build OpENer for Windows is to either use MinGW or Visual Studio.
|
|
|
@@ -88,7 +84,7 @@ Compile for MinGW on Windows XP/7/8/10
|
|
|
1. Make sure 64 bit mingw is installed. (Test with gcc --version, should show x86_64-posix-seh-rev1)
|
|
|
2. Make sure CMake is installed. (Test with cmake --version, should be version 3.xx)
|
|
|
3. Change to <opener install dir>/bin/mingw
|
|
|
-4. Run the command `setup_mingw.bat` in a dos command line. (Not a bash shell). If tracing is desired,
|
|
|
+4. Run the command `setup_mingw.bat` in a dos command line. (Not a bash shell). If tracing is desired,
|
|
|
use the following (where the cmake parameter must be enclosed in quotes) or change the ./source/CMakeList.txt file.
|
|
|
```
|
|
|
setup_mingw.bat "-DOpENer_TRACES:BOOL=TRUE"
|
|
|
@@ -96,7 +92,7 @@ use the following (where the cmake parameter must be enclosed in quotes) or chan
|
|
|
5. Run the command "make" from the same directory (./bin/mingw)
|
|
|
6. The opener.exe is now found in <opener install dir>\bin\mingw\src\ports\MINGW
|
|
|
7. Start it like this: "opener 192.168.250.22", where the ip address is the local computer's address on the nettwork you want to use.
|
|
|
-
|
|
|
+
|
|
|
Directory structure:
|
|
|
--------------------
|
|
|
- bin ... The resulting binaries and make files for different ports
|
|
|
@@ -115,18 +111,18 @@ Directory structure:
|
|
|
|
|
|
Documentation:
|
|
|
--------------
|
|
|
-The documentation of the functions of OpENer is part of the source code. The source
|
|
|
-packages contain the generated documentation in the directory doc/api_doc. If you
|
|
|
-use the GIT version you will need the program Doxygen for generating the HTML
|
|
|
-documentation. You can generate the documentation by invoking doxygen from the
|
|
|
+The documentation of the functions of OpENer is part of the source code. The source
|
|
|
+packages contain the generated documentation in the directory doc/api_doc. If you
|
|
|
+use the GIT version you will need the program Doxygen for generating the HTML
|
|
|
+documentation. You can generate the documentation by invoking doxygen from the
|
|
|
command line in the opener main directory.
|
|
|
|
|
|
|
|
|
Fuzzing
|
|
|
--------------
|
|
|
### Intro
|
|
|
-Fuzzing is an automated testing method that directs varying input data to a program in
|
|
|
-order to monitor output. It is a way to test for overall reliability as well as identify
|
|
|
+Fuzzing is an automated testing method that directs varying input data to a program in
|
|
|
+order to monitor output. It is a way to test for overall reliability as well as identify
|
|
|
potential security bugs.
|
|
|
|
|
|
The fuzzer we are using is AFL, a fuzzer that uses runtime guided techniques to create input for the tested program. From a high-level prespective AFL works as follows:
|
|
|
@@ -152,7 +148,7 @@ echo "AFL is ready at: $(which afl-fuzz)"
|
|
|
|
|
|
Then, compile OpENer with AFL:
|
|
|
1. Change to the ``OpENer/bin/posix`` directory
|
|
|
-2. Compile OpENer with AFL ``./setup_posix_fuzz_afl.sh``
|
|
|
+2. Compile OpENer with AFL ``./setup_posix_fuzz_afl.sh``
|
|
|
3. Run ``make``
|
|
|
|
|
|
### Fuzz
|
|
|
@@ -205,7 +201,7 @@ Shut down all the instances: docker-compose down
|
|
|
|
|
|
Porting OpENer:
|
|
|
---------------
|
|
|
-For porting OpENer to new platforms please see the porting section in the
|
|
|
+For porting OpENer to new platforms please see the porting section in the
|
|
|
Doxygen documentation.
|
|
|
|
|
|
Contributing to OpENer:
|