recipes-connectivity/kuksa-val/kuksa-val/0003-Make-install-locations-configurable.patch

   1 From f73106b1f204b49930922e8bb4d1fdec6ac64b7d Mon Sep 17 00:00:00 2001
   2 From: Scott Murray <scott.murray@konsulko.com>
   3 Date: Sat, 5 Aug 2023 12:19:45 -0400
   4 Subject: [PATCH 5/5] Make install locations configurable
   5
   6 Make binary, certificate, and configuration file install locations
   7 configurable, including generation and installation of an accurate
   8 default config.ini as well as a header file so that the server
   9 binary uses the specified defaults.  This allows configuring a
  10 build that installs files into locations more along the lines of
  11 the Linux FHS.  An effort has been made to ensure that the previous
  12 default locations are maintained.
  13
  14 Upstream-Status: Pending
  15
  16 Signed-off-by: Scott Murray <scott.murray@konsulko.com>
  17 ---
  18  kuksa-val-server/config.ini         |  7 ----
  19  kuksa-val-server/config.ini.in      |  7 ++++
  20  kuksa-val-server/src/CMakeLists.txt | 59 +++++++++++++++++++++--------
  21  kuksa-val-server/src/config.hpp.in  | 27 +++++++++++++
  22  kuksa-val-server/src/main.cpp       |  5 ++-
  23  5 files changed, 81 insertions(+), 24 deletions(-)
  24  delete mode 100644 kuksa-val-server/config.ini
  25  create mode 100644 kuksa-val-server/config.ini.in
  26  create mode 100644 kuksa-val-server/src/config.hpp.in
  27
  28 diff --git a/kuksa-val-server/config.ini b/kuksa-val-server/config.ini
  29 deleted file mode 100644
  30 index 8fcd63c..0000000
  31 --- a/kuksa-val-server/config.ini
  32 +++ /dev/null
  33 @@ -1,7 +0,0 @@
  34 -vss = vss_release_4.0.json
  35 -log-level = ALL
  36 -cert-path = .
  37 -
  38 -[mqtt]
  39 -    publish =
  40 -    topic-prefix = vss
  41 diff --git a/kuksa-val-server/config.ini.in b/kuksa-val-server/config.ini.in
  42 new file mode 100644
  43 index 0000000..3793bd6
  44 --- /dev/null
  45 +++ b/kuksa-val-server/config.ini.in
  46 @@ -0,0 +1,7 @@
  47 +vss = @KUKSA_DEFAULT_DATADIR@/vss_release_4.0.json
  48 +log-level = ALL
  49 +cert-path = @KUKSA_DEFAULT_CERTDIR@
  50 +
  51 +[mqtt]
  52 +    publish =
  53 +    topic-prefix = vss
  54 diff --git a/kuksa-val-server/src/CMakeLists.txt b/kuksa-val-server/src/CMakeLists.txt
  55 index 908c66c..b749a7a 100644
  56 --- a/kuksa-val-server/src/CMakeLists.txt
  57 +++ b/kuksa-val-server/src/CMakeLists.txt
  58 @@ -161,6 +161,35 @@ if(BUILD_EXE)
  59    ######
  60    # Setup server install and packaging
  61
  62 +  set(KUKSA_INSTALL_BINDIR "bin/${SERVER_EXE_NAME}" CACHE STRING "Server binary install directory")
  63 +
  64 +  if(DEFINED KUKSA_INSTALL_DATADIR)
  65 +    set(KUKSA_DEFAULT_DATADIR_INTERNAL "${KUKSA_INSTALL_DATADIR}")
  66 +  else()
  67 +    set(KUKSA_DEFAULT_DATADIR_INTERNAL ".")
  68 +  endif()
  69 +  set(KUKSA_INSTALL_DATADIR "${KUKSA_INSTALL_BINDIR}" CACHE STRING "Data install directory")
  70 +  set(KUKSA_DEFAULT_DATADIR "${KUKSA_DEFAULT_DATADIR_INTERNAL}" CACHE STRING "Default data location")
  71 +
  72 +  if(DEFINED KUKSA_INSTALL_CONFIGDIR)
  73 +    set(KUKSA_DEFAULT_CONFIG "${KUKSA_INSTALL_CONFIGDIR}/config.ini" CACHE STRING "Default config.ini location")
  74 +  else()
  75 +    set(KUKSA_DEFAULT_CONFIG "config.ini" CACHE STRING "Default config.ini location")
  76 +  endif()
  77 +  set(KUKSA_INSTALL_CONFIGDIR "${KUKSA_INSTALL_BINDIR}" CACHE STRING "config.ini install directory")
  78 +
  79 +  if(DEFINED KUKSA_INSTALL_CERTDIR)
  80 +    set(KUKSA_DEFAULT_CERTDIR_INTERNAL "${KUKSA_INSTALL_CERTDIR}")
  81 +  else()
  82 +    set(KUKSA_DEFAULT_CERTDIR_INTERNAL ".")
  83 +  endif()
  84 +  set(KUKSA_INSTALL_CERTDIR "${KUKSA_INSTALL_BINDIR}" CACHE STRING "Certificate install directory")
  85 +  set(KUKSA_DEFAULT_CERTDIR "${KUKSA_DEFAULT_CERTDIR_INTERNAL}" CACHE STRING "Default certificate location")
  86 +
  87 +  # Generate header for main.cpp to pick up default locations
  88 +  configure_file(config.hpp.in config.hpp @ONLY)
  89 +  include_directories(${CMAKE_CURRENT_BINARY_DIR})
  90 +
  91    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/jwt/jwt.key.pub  ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
  92    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Server.pem  ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
  93    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Server.key  ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
  94 @@ -173,23 +202,23 @@ if(BUILD_EXE)
  95    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_3.0.json ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
  96    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_3.1.1.json ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
  97    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_4.0.json ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
  98 -  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../config.ini ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
  99 +  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../config.ini.in ${CMAKE_CURRENT_BINARY_DIR}/config.ini @COPY)
 100    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../config_grpc_client.ini ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
 101
 102 -  install( TARGETS ${SERVER_EXE_NAME} DESTINATION bin/${SERVER_EXE_NAME})
 103 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/jwt/jwt.key.pub DESTINATION bin/${SERVER_EXE_NAME})
 104 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Server.pem DESTINATION bin/${SERVER_EXE_NAME})
 105 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Server.key DESTINATION bin/${SERVER_EXE_NAME})
 106 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Client.pem DESTINATION bin/${SERVER_EXE_NAME})
 107 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Client.key DESTINATION bin/${SERVER_EXE_NAME})
 108 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/CA.pem DESTINATION bin/${SERVER_EXE_NAME})
 109 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_2.0.json DESTINATION bin/${SERVER_EXE_NAME})
 110 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_2.1.json DESTINATION bin/${SERVER_EXE_NAME})
 111 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_2.2.json DESTINATION bin/${SERVER_EXE_NAME})
 112 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_3.0.json DESTINATION bin/${SERVER_EXE_NAME})
 113 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_3.1.1.json DESTINATION bin/${SERVER_EXE_NAME})
 114 -  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_4.0.json DESTINATION bin/${SERVER_EXE_NAME})
 115 -
 116 +  install( TARGETS ${SERVER_EXE_NAME} DESTINATION ${KUKSA_INSTALL_BINDIR})
 117 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/jwt/jwt.key.pub DESTINATION ${KUKSA_INSTALL_CERTDIR})
 118 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Server.pem DESTINATION ${KUKSA_INSTALL_CERTDIR})
 119 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Server.key DESTINATION ${KUKSA_INSTALL_CERTDIR})
 120 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Client.pem DESTINATION ${KUKSA_INSTALL_CERTDIR})
 121 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/Client.key DESTINATION ${KUKSA_INSTALL_CERTDIR})
 122 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../kuksa_certificates/CA.pem DESTINATION ${KUKSA_INSTALL_CERTDIR})
 123 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_2.0.json DESTINATION ${KUKSA_INSTALL_DATADIR})
 124 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_2.1.json DESTINATION ${KUKSA_INSTALL_DATADIR})
 125 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_2.2.json DESTINATION ${KUKSA_INSTALL_DATADIR})
 126 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_3.0.json DESTINATION ${KUKSA_INSTALL_DATADIR})
 127 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_3.1.1.json DESTINATION ${KUKSA_INSTALL_DATADIR})
 128 +  install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/../../data/vss-core/vss_release_4.0.json DESTINATION ${KUKSA_INSTALL_DATADIR})
 129 +  install( FILES ${CMAKE_CURRENT_BINARY_DIR}/config.ini DESTINATION ${KUKSA_INSTALL_CONFIGDIR})
 130
 131    # CPack
 132    INCLUDE(InstallRequiredSystemLibraries)
 133 diff --git a/kuksa-val-server/src/config.hpp.in b/kuksa-val-server/src/config.hpp.in
 134 new file mode 100644
 135 index 0000000..24226d2
 136 --- /dev/null
 137 +++ b/kuksa-val-server/src/config.hpp.in
 138 @@ -0,0 +1,27 @@
 139 +/**********************************************************************
 140 + * Copyright (c) 2022 Konsulko Group
 141 + *
 142 + * Licensed under the Apache License, Version 2.0 (the "License");
 143 + * you may not use this file except in compliance with the License.
 144 + * You may obtain a copy of the License at
 145 + *
 146 + *    http://www.apache.org/licenses/LICENSE-2.0
 147 + *
 148 + * Unless required by applicable law or agreed to in writing, software
 149 + * distributed under the License is distributed on an "AS IS" BASIS,
 150 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 151 + * See the License for the specific language governing permissions and
 152 + * limitations under the License.
 153 + *
 154 + *  SPDX-License-Identifier: Apache-2.0
 155 + **********************************************************************/
 156 +
 157 +#ifndef __CONFIG_H___
 158 +
 159 +// Default configuration file location
 160 +#cmakedefine KUKSA_DEFAULT_CONFIG "@KUKSA_DEFAULT_CONFIG@"
 161 +
 162 +// Default Certificate directory
 163 +#cmakedefine KUKSA_DEFAULT_CERTDIR "@KUKSA_DEFAULT_CERTDIR@"
 164 +
 165 +#endif
 166 diff --git a/kuksa-val-server/src/main.cpp b/kuksa-val-server/src/main.cpp
 167 index f3e6dd1..8346188 100644
 168 --- a/kuksa-val-server/src/main.cpp
 169 +++ b/kuksa-val-server/src/main.cpp
 170 @@ -47,6 +47,7 @@
 171  #include "exception.hpp"
 172  #include "grpcHandler.hpp"
 173  #include "OverlayLoader.hpp"
 174 +#include "config.hpp"
 175
 176
 177  #include "../buildinfo.h"
 178 @@ -107,7 +108,7 @@ int main(int argc, const char *argv[]) {
 179    program_options::options_description desc{"OPTIONS"};
 180    desc.add_options()
 181      ("help,h", "Help screen")
 182 -    ("config-file,c", program_options::value<boost::filesystem::path>()->default_value(boost::filesystem::path{"config.ini"}),
 183 +    ("config-file,c", program_options::value<boost::filesystem::path>()->default_value(boost::filesystem::path{KUKSA_DEFAULT_CONFIG}),
 184        "Configuration file with `kuksa-val-server` input parameters."
 185        "Configuration file can replace command-line parameters and through different files multiple configurations can be handled more easily (e.g. test and production setup)."
 186        "Sample of configuration file parameters looks like:\n"
 187 @@ -116,7 +117,7 @@ int main(int argc, const char *argv[]) {
 188        "log-level = ALL\n")
 189      ("vss", program_options::value<boost::filesystem::path>()->required(), "[mandatory] Path to VSS data file describing VSS data tree structure which `kuksa-val-server` shall handle. Sample 'vss_release_4.0.json' file can be found under [data](./data/vss-core/vss_release_4.0.json)")
 190      ("overlays", program_options::value<boost::filesystem::path>(), "Path to a directory cotaiing additional VSS models. All json files will be applied on top of the main vss file given by the -vss parameter in alphanumerical order")
 191 -    ("cert-path", program_options::value<boost::filesystem::path>()->required()->default_value(boost::filesystem::path(".")),
 192 +    ("cert-path", program_options::value<boost::filesystem::path>()->required()->default_value(boost::filesystem::path(KUKSA_DEFAULT_CERTDIR)),
 193        "[mandatory] Directory path where 'Server.pem', 'Server.key' and 'jwt.key.pub' are located. ")
 194      ("insecure", program_options::bool_switch()->default_value(false), "By default, `kuksa-val-server` shall accept only SSL (TLS) secured connections. If provided, `kuksa-val-server` shall also accept plain un-secured connections for Web-Socket and GRPC API connections, and also shall not fail connections due to self-signed certificates.")
 195      ("use-keycloak", "Use KeyCloak for permission management")
 196 --
 197 2.41.0
 198