shibd/shibd.cpp

   1 /*\r
   2  *  Copyright 2001-2009 Internet2\r
   3  *\r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /*\r
  18  * shar.cpp -- the shibd "main" code.  All the functionality is elsewhere\r
  19  *\r
  20  * Created By:  Derek Atkins <derek@ihtfp.com>\r
  21  *\r
  22  * $Id: shar.cpp 2164 2007-02-11 05:26:18 +0000 (Sun, 11 Feb 2007) cantor $\r
  23  */\r
  24 \r
  25 \r
  26 // eventually we might be able to support autoconf via cygwin...\r
  27 #if defined (_MSC_VER) || defined(__BORLANDC__)\r
  28 # include "config_win32.h"\r
  29 #else\r
  30 # include "config.h"\r
  31 #endif\r
  32 \r
  33 #ifdef WIN32\r
  34 # define _CRT_NONSTDC_NO_DEPRECATE 1\r
  35 # define _CRT_SECURE_NO_DEPRECATE 1\r
  36 #endif\r
  37 \r
  38 #include <shibsp/SPConfig.h>\r
  39 \r
  40 #ifdef HAVE_UNISTD_H\r
  41 #include <unistd.h>\r
  42 #include <sys/select.h>\r
  43 #endif\r
  44 \r
  45 #include <stdio.h>\r
  46 #include <signal.h>\r
  47 #include <shibsp/ServiceProvider.h>\r
  48 #include <shibsp/remoting/ListenerService.h>\r
  49 #include <xercesc/util/XMLUniDefs.hpp>\r
  50 #include <xmltooling/XMLToolingConfig.h>\r
  51 #include <xmltooling/util/XMLConstants.h>\r
  52 #include <xmltooling/util/XMLHelper.h>\r
  53 \r
  54 using namespace shibsp;\r
  55 using namespace xmltooling;\r
  56 using namespace std;\r
  57 \r
  58 bool shibd_shutdown = false;\r
  59 const char* shar_config = NULL;\r
  60 const char* shar_schemadir = NULL;\r
  61 const char* shar_prefix = NULL;\r
  62 bool shar_checkonly = false;\r
  63 bool shar_version = false;\r
  64 static bool unlink_socket = false;\r
  65 const char* pidfile = NULL;\r
  66 \r
  67 #ifdef WIN32\r
  68 \r
  69 //#include <CRTDBG.H>\r
  70 \r
  71 #define nNoMansLandSize 4\r
  72 typedef struct _CrtMemBlockHeader\r
  73 {\r
  74         struct _CrtMemBlockHeader * pBlockHeaderNext;\r
  75         struct _CrtMemBlockHeader * pBlockHeaderPrev;\r
  76         char *                      szFileName;\r
  77         int                         nLine;\r
  78         size_t                      nDataSize;\r
  79         int                         nBlockUse;\r
  80         long                        lRequest;\r
  81         unsigned char               gap[nNoMansLandSize];\r
  82         /* followed by:\r
  83          *  unsigned char           data[nDataSize];\r
  84          *  unsigned char           anotherGap[nNoMansLandSize];\r
  85          */\r
  86 } _CrtMemBlockHeader;\r
  87 \r
  88 /*\r
  89 int MyAllocHook(int nAllocType, void *pvData,\r
  90       size_t nSize, int nBlockUse, long lRequest,\r
  91       const unsigned char * szFileName, int nLine)\r
  92 {\r
  93     if ( nBlockUse == _CRT_BLOCK )\r
  94       return( TRUE );\r
  95     if (nAllocType == _HOOK_FREE) {\r
  96         _CrtMemBlockHeader* ptr = (_CrtMemBlockHeader*)(((_CrtMemBlockHeader *)pvData)-1);\r
  97         if (ptr->nDataSize == 8192)\r
  98             fprintf(stderr,"free  request %u size %u\n", ptr->lRequest, ptr->nDataSize);\r
  99     }\r
 100     else if (nAllocType == _HOOK_ALLOC && nSize == 8192)\r
 101         fprintf(stderr,"%s request %u size %u\n", ((nAllocType == _HOOK_ALLOC) ? "alloc" : "realloc"), lRequest, nSize);\r
 102     return (TRUE);\r
 103 }\r
 104 */\r
 105 \r
 106 int real_main(int preinit)\r
 107 {\r
 108     SPConfig& conf=SPConfig::getConfig();\r
 109     if (preinit) {\r
 110 \r
 111         // Initialize the SP library.\r
 112         conf.setFeatures(\r
 113             SPConfig::Listener |\r
 114             SPConfig::Caching |\r
 115             SPConfig::Metadata |\r
 116             SPConfig::Trust |\r
 117             SPConfig::Credentials |\r
 118             SPConfig::AttributeResolution |\r
 119             SPConfig::Handlers |\r
 120             SPConfig::OutOfProcess |\r
 121             (shar_checkonly ? SPConfig::RequestMapping : SPConfig::Logging)\r
 122             );\r
 123         if (!conf.init(shar_schemadir, shar_prefix)) {\r
 124             fprintf(stderr, "configuration is invalid, see console for specific problems\n");\r
 125             return -1;\r
 126         }\r
 127 \r
 128         if (!conf.instantiate(shar_config)) {\r
 129             fprintf(stderr, "configuration is invalid, check console for specific problems\n");\r
 130             conf.term();\r
 131             return -2;\r
 132         }\r
 133 \r
 134         // If just a test run, bail.\r
 135         if (shar_checkonly) {\r
 136             fprintf(stdout, "overall configuration is loadable, check console for non-fatal problems\n");\r
 137             return 0;\r
 138         }\r
 139     }\r
 140     else {\r
 141 \r
 142         //_CrtSetAllocHook(MyAllocHook);\r
 143 \r
 144         if (!shar_checkonly) {\r
 145             // Run the listener.\r
 146             if (!conf.getServiceProvider()->getListenerService()->run(unlink_socket, &shibd_shutdown)) {\r
 147                 fprintf(stderr, "listener failed to enter listen loop\n");\r
 148                 return -3;\r
 149             }\r
 150         }\r
 151 \r
 152         conf.term();\r
 153     }\r
 154     return 0;\r
 155 }\r
 156 \r
 157 #else\r
 158 \r
 159 int daemon_wait = 3;\r
 160 bool shibd_running = false;\r
 161 bool daemonize = true;\r
 162 \r
 163 static void term_handler(int arg)\r
 164 {\r
 165     shibd_shutdown = true;\r
 166 }\r
 167 \r
 168 static void run_handler(int arg)\r
 169 {\r
 170     shibd_running = true;\r
 171 }\r
 172 \r
 173 static int setup_signals(void)\r
 174 {\r
 175     struct sigaction sa;\r
 176     memset(&sa, 0, sizeof (sa));\r
 177     sa.sa_handler = SIG_IGN;\r
 178     sa.sa_flags = SA_RESTART;\r
 179 \r
 180     if (sigaction(SIGPIPE, &sa, NULL) < 0) {\r
 181         return -1;\r
 182     }\r
 183 \r
 184     memset(&sa, 0, sizeof (sa));\r
 185     sa.sa_handler = term_handler;\r
 186     sa.sa_flags = SA_RESTART;\r
 187 \r
 188     if (sigaction(SIGHUP, &sa, NULL) < 0) {\r
 189         return -1;\r
 190     }\r
 191     if (sigaction(SIGINT, &sa, NULL) < 0) {\r
 192         return -1;\r
 193     }\r
 194     if (sigaction(SIGQUIT, &sa, NULL) < 0) {\r
 195         return -1;\r
 196     }\r
 197     if (sigaction(SIGTERM, &sa, NULL) < 0) {\r
 198         return -1;\r
 199     }\r
 200 \r
 201     if (daemonize) {\r
 202         memset(&sa, 0, sizeof (sa));\r
 203         sa.sa_handler = run_handler;\r
 204 \r
 205         if (sigaction(SIGUSR1, &sa, NULL) < 0) {\r
 206             return -1;\r
 207         }\r
 208     }\r
 209 \r
 210     return 0;\r
 211 }\r
 212 \r
 213 static void usage(char* whoami)\r
 214 {\r
 215     fprintf(stderr, "usage: %s [-dcxtfpvh]\n", whoami);\r
 216     fprintf(stderr, "  -d\tinstallation prefix to use.\n");\r
 217     fprintf(stderr, "  -c\tconfig file to use.\n");\r
 218     fprintf(stderr, "  -x\tXML schema catalogs to use.\n");\r
 219     fprintf(stderr, "  -t\ttest configuration file for problems.\n");\r
 220     fprintf(stderr, "  -f\tforce removal of listener socket.\n");\r
 221     fprintf(stderr, "  -F\tstay in the foreground.\n");\r
 222     fprintf(stderr, "  -p\tpid file to use.\n");\r
 223     fprintf(stderr, "  -w\tseconds to wait for successful daemonization.\n");\r
 224     fprintf(stderr, "  -v\tprint software version.\n");\r
 225     fprintf(stderr, "  -h\tprint this help message.\n");\r
 226     exit(1);\r
 227 }\r
 228 \r
 229 static int parse_args(int argc, char* argv[])\r
 230 {\r
 231     int opt;\r
 232 \r
 233     while ((opt = getopt(argc, argv, "d:c:x:p:w:fFtvh")) > 0) {\r
 234         switch (opt) {\r
 235             case 'd':\r
 236                 shar_prefix=optarg;\r
 237                 break;\r
 238             case 'c':\r
 239                 shar_config=optarg;\r
 240                 break;\r
 241             case 'x':\r
 242                 shar_schemadir=optarg;\r
 243                 break;\r
 244             case 'f':\r
 245                 unlink_socket = true;\r
 246                 break;\r
 247             case 'F':\r
 248                 daemonize = false;\r
 249                 break;\r
 250             case 't':\r
 251                 shar_checkonly=true;\r
 252                 break;\r
 253             case 'v':\r
 254                 shar_version=true;\r
 255                 break;\r
 256             case 'p':\r
 257                 pidfile=optarg;\r
 258                 break;\r
 259             case 'w':\r
 260                 if (optarg)\r
 261                     daemon_wait = atoi(optarg);\r
 262                 if (daemon_wait <= 0)\r
 263                     daemon_wait = 3;\r
 264                 break;\r
 265             default:\r
 266                 return -1;\r
 267         }\r
 268     }\r
 269     return 0;\r
 270 }\r
 271 \r
 272 int main(int argc, char *argv[])\r
 273 {\r
 274     if (parse_args(argc, argv) != 0)\r
 275         usage(argv[0]);\r
 276     else if (shar_version) {\r
 277         fprintf(stdout, PACKAGE_STRING"\n");\r
 278         return 0;\r
 279     }\r
 280 \r
 281     if (setup_signals() != 0)\r
 282         return -1;\r
 283 \r
 284     // initialize the shib-target library\r
 285     SPConfig& conf=SPConfig::getConfig();\r
 286     conf.setFeatures(\r
 287         SPConfig::Listener |\r
 288         SPConfig::Caching |\r
 289         SPConfig::Metadata |\r
 290         SPConfig::Trust |\r
 291         SPConfig::Credentials |\r
 292         SPConfig::AttributeResolution |\r
 293         SPConfig::Handlers |\r
 294         SPConfig::OutOfProcess |\r
 295         (shar_checkonly ? SPConfig::RequestMapping : SPConfig::Logging)\r
 296         );\r
 297     if (!conf.init(shar_schemadir, shar_prefix)) {\r
 298         fprintf(stderr, "configuration is invalid, check console for specific problems\n");\r
 299         return -1;\r
 300     }\r
 301 \r
 302     if (daemonize) {\r
 303         // We must fork() early, while we're single threaded.\r
 304         // StorageService cleanup thread is about to start.\r
 305         if (!shar_checkonly) {\r
 306             switch (fork()) {\r
 307                 case 0:\r
 308                     break;\r
 309                 case -1:\r
 310                     perror("forking");\r
 311                     exit(EXIT_FAILURE);\r
 312                 default:\r
 313                     sleep(daemon_wait);\r
 314                     exit(shibd_running ? EXIT_SUCCESS : EXIT_FAILURE);\r
 315             }\r
 316         }\r
 317     }\r
 318 \r
 319     if (!conf.instantiate(shar_config)) {\r
 320         fprintf(stderr, "configuration is invalid, check console for specific problems\n");\r
 321         conf.term();\r
 322         return -2;\r
 323     }\r
 324 \r
 325     if (shar_checkonly)\r
 326         fprintf(stderr, "overall configuration is loadable, check console for non-fatal problems\n");\r
 327     else {\r
 328         if (daemonize) {\r
 329             if (setsid() == -1) {\r
 330                 perror("setsid");\r
 331                 exit(EXIT_FAILURE);\r
 332             }\r
 333             if (chdir("/") == -1) {\r
 334                 perror("chdir to root");\r
 335                 exit(EXIT_FAILURE);\r
 336             }\r
 337         }\r
 338 \r
 339         // Write the pid file\r
 340         if (pidfile) {\r
 341             FILE* pidf = fopen(pidfile, "w");\r
 342             if (pidf) {\r
 343                 fprintf(pidf, "%d\n", getpid());\r
 344                 fclose(pidf);\r
 345             } else {\r
 346                 perror(pidfile);  // keep running though\r
 347             }\r
 348         }\r
 349 \r
 350         if (daemonize) {\r
 351             freopen("/dev/null", "r", stdin);\r
 352             freopen("/dev/null", "w", stdout);\r
 353             freopen("/dev/null", "w", stderr);\r
 354             if (!conf.getServiceProvider()->getListenerService()->setSignal(SIGUSR1)) {\r
 355                 fprintf(stderr, "listener failed to accept signaling hook\n");\r
 356                 return -3;\r
 357             }\r
 358         }\r
 359 \r
 360         // Run the listener\r
 361         if (!conf.getServiceProvider()->getListenerService()->run(unlink_socket, &shibd_shutdown)) {\r
 362             fprintf(stderr, "listener failed to enter listen loop\n");\r
 363             return -3;\r
 364         }\r
 365     }\r
 366 \r
 367     conf.term();\r
 368     if (pidfile)\r
 369         unlink(pidfile);\r
 370     return 0;\r
 371 }\r
 372 \r
 373 #endif\r