[comment]: # ({1f267b18-1f267b18})
# Building Zabbix agent on Windows
[comment]: # ({/1f267b18-1f267b18})
[comment]: # ({2cee80d5-2cee80d5})
#### Overview
This section demonstrates how to build Zabbix Windows agent binaries
from sources with or without TLS.
[comment]: # ({/2cee80d5-2cee80d5})
[comment]: # ({0aeae349-8b346a36})
#### Compiling OpenSSL
The following steps will help you to compile OpenSSL from sources on MS
Windows 10 (64-bit).
1. For compiling OpenSSL you will need on Windows machine:
1. C compiler (e.g. VS 2017 RC),
2. NASM (),
3. Perl (e.g. Strawberry Perl from ),
4. Perl module Text::Template (cpan Text::Template).
2. Get OpenSSL sources from . OpenSSL 1.1.1
is used here.
3. Unpack OpenSSL sources, for example, in E:\\openssl-1.1.1.
4. Open a commandline window e.g. the x64 Native Tools Command Prompt
for VS 2017 RC.
5. Go to the OpenSSL source directory, e.g. E:\\openssl-1.1.1.
1. Verify that NASM can be found:`e:\openssl-1.1.1> nasm --version
NASM version 2.13.01 compiled on May 1 2017
`
6. Configure OpenSSL, for
example:`e:\openssl-1.1.1> perl E:\openssl-1.1.1\Configure VC-WIN64A no-shared no-capieng no-srp no-gost no-dgram no-dtls1-method no-dtls1_2-method --api=1.1.0 --prefix=C:\OpenSSL-Win64-111-static --openssldir=C:\OpenSSL-Win64-111-static
`
- Make sure to revoke write access from non-administrator users to the
OpenSSL install directory (`C:\OpenSSL-Win64-111-static`). Otherwise,
Zabbix agent will load SSL settings from a path that can be modified
by unprivileged users, resulting in a potential security vulnerability.
- Note the option 'no-shared': if 'no-shared' is used then the
OpenSSL static libraries libcrypto.lib and libssl.lib will be
'self-sufficient' and resulting Zabbix binaries will include
OpenSSL in themselves, no need for external OpenSSL DLLs.
Advantage: Zabbix binaries can be copied to other Windows
machines without OpenSSL libraries. Disadvantage: when a new
OpenSSL bugfix version is released, Zabbix agent needs to
recompiled and reinstalled.
- If 'no-shared' is not used, then the static libraries
libcrypto.lib and libssl.lib will be using OpenSSL DLLs at
runtime. Advantage: when a new OpenSSL bugfix version is
released, probably you can upgrade only OpenSSL DLLs, without
recompiling Zabbix agent. Disadvantage: copying Zabbix agent to
another machine requires copying OpenSSL DLLs, too.
7. Compile OpenSSL, run tests, install:`e:\openssl-1.1.1> nmake
e:\openssl-1.1.1> nmake test
...
All tests successful.
Files=152, Tests=1152, 501 wallclock secs ( 0.67 usr + 0.61 sys = 1.28 CPU)
Result: PASS
e:\openssl-1.1.1> nmake install_sw
`'install\_sw' installs only software components (i.e. libraries,
header files, but no documentation). If you want everything, use
"nmake install".
[comment]: # ({/0aeae349-8b346a36})
[comment]: # ({747699c3-0c2d9aa0})
#### Compiling PCRE
1. Download the PCRE (not PCRE2) library (mandatory library since Zabbix 4.0) from .
2. Extract to directory *E:\\pcre-8.41*.
3. Install CMake from , during install
select: and ensure that cmake\\bin is on your path (tested version
3.9.4).
4. Create a new, empty build directory, preferably a subdirectory of
the source dir. For example, *E:\\pcre-8.41\\build*.
5. Open a commandline window e.g. the x64 Native Tools Command Prompt
for VS 2017 and from that shell environment run cmake-gui. Do not
try to start Cmake from the Windows Start menu, as this can lead to
errors.
6. Enter *E:\\pcre-8.41* and *E:\\pcre-8.41\\build* for the source and
build directories, respectively.
7. Hit the "Configure" button.
8. When specifying the generator for this project select "NMake
Makefiles".
9. Create a new, empty install directory. For example,
*E:\\pcre-8.41-install*.
10. The GUI will then list several configuration options. Make sure the
following options are selected:
- **PCRE\_SUPPORT\_UNICODE\_PROPERTIES** ON
- **PCRE\_SUPPORT\_UTF** ON
- **CMAKE\_INSTALL\_PREFIX** *E:\\pcre-8.41-install*
11. Hit "Configure" again. The adjacent "Generate" button should now be
active.
12. Hit "Generate".
13. In the event that errors occur, it is recommended that you delete
the CMake cache before attempting to repeat the CMake build process.
In the CMake GUI, the cache can be deleted by selecting "File >
Delete Cache".
14. The build directory should now contain a usable build system -
*Makefile*.
15. Open a commandline window e.g. the x64 Native Tools Command Prompt
for VS 2017 and navigate to the *Makefile* mentioned above.
16. Run NMake command: `E:\pcre-8.41\build> nmake install
`
[comment]: # ({/747699c3-0c2d9aa0})
[comment]: # ({3c4efc37-3c4efc37})
#### Compiling Zabbix
The following steps will help you to compile Zabbix from sources on MS
Windows 10 (64-bit). When compiling Zabbix with/without TLS support the
only significant difference is in step 4.
1. On a Linux machine check out the source from
GIT:`` $ git clone https://git.zabbix.com/scm/zbx/zabbix.git
$ cd zabbix/
$ git checkout 5.0.1 -b 5.0.1 # replace 5.0.1 with the latest release available
$ ./bootstrap.sh
$ ./configure --enable-agent --enable-ipv6 --prefix=`pwd`
$ make dbschema
$ make dist
``
2. Copy and unpack the archive, e.g. zabbix-5.0.0.tar.gz, on a Windows
machine.
3. Let's assume that sources are in e:\\zabbix-5.0.0. Open a
commandline window e.g. the x64 Native Tools Command Prompt for VS
2017 RC. Go to E:\\zabbix-5.0.0\\build\\win32\\project.
4. Compile zabbix\_get, zabbix\_sender and zabbix\_agent.
- without TLS:
`E:\zabbix-5.0.0\build\win32\project> nmake /K PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
`
- with TLS:
`E:\zabbix-5.0.0\build\win32\project> nmake /K -f Makefile_get TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
E:\zabbix-5.0.0\build\win32\project> nmake /K -f Makefile_sender TLS=openssl TLSINCDIR="C:\OpenSSL-Win64-111-static\include TLSLIBDIR="C:\OpenSSL-Win64-111-static\lib" PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
E:\zabbix-5.0.0\build\win32\project> nmake /K -f Makefile_agent TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
`
5. New binaries are located in e:\\zabbix-5.0.0\\bin\\win64. Since
OpenSSL was compiled with 'no-shared' option, Zabbix binaries
contain OpenSSL within themselves and can be copied to other
machines that do not have OpenSSL.
[comment]: # ({/3c4efc37-3c4efc37})
[comment]: # ({f29d84a2-c8fe4039})
#### Compiling Zabbix with LibreSSL
The process is similar to compiling with OpenSSL, but you need to make
small changes in files located in the `build\win32\project` directory:
- In Makefile_tls delete `/DHAVE_OPENSSL_WITH_PSK`, i.e. find:
```
CFLAGS = $(CFLAGS) /DHAVE_OPENSSL /DHAVE_OPENSSL_WITH_PSK
```
and replace it with
```
CFLAGS = $(CFLAGS) /DHAVE_OPENSSL
```
- In Makefile_common.inc add `/NODEFAULTLIB:LIBCMT` i.e. find:
```
/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO /PDB:$(TARGETDIR)\$(TARGETNAME).pdb
```
and replace it with
```
/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO /PDB:$(TARGETDIR)\$(TARGETNAME).pdb /NODEFAULTLIB:LIBCMT
```
[comment]: # ({/f29d84a2-c8fe4039})