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             ListenerService* listener = conf.getServiceProvider()->getListenerService();\r
 147             if (!listener->init(unlink_socket)) {\r
 148                 fprintf(stderr, "listener failed to initialize\n");\r
 149                 conf.term();\r
 150                 return -3;\r
 151             }\r
 152             else if (!listener->run(&shibd_shutdown)) {\r
 153                 fprintf(stderr, "listener failed during service\n");\r
 154                 listener->term();\r
 155                 conf.term();\r
 156                 return -3;\r
 157             }\r
 158             listener->term();\r
 159         }\r
 160 \r
 161         conf.term();\r
 162     }\r
 163     return 0;\r
 164 }\r
 165 \r
 166 #else\r
 167 \r
 168 int daemon_wait = 3;\r
 169 bool shibd_running = false;\r
 170 bool daemonize = true;\r
 171 \r
 172 static void term_handler(int arg)\r
 173 {\r
 174     shibd_shutdown = true;\r
 175 }\r
 176 \r
 177 static void run_handler(int arg)\r
 178 {\r
 179     shibd_running = true;\r
 180 }\r
 181 \r
 182 static void child_handler(int arg)\r
 183 {\r
 184     // Terminate the parent's wait/sleep if the newly born daemon dies early.\r
 185 }\r
 186 \r
 187 static int setup_signals(void)\r
 188 {\r
 189     struct sigaction sa;\r
 190     memset(&sa, 0, sizeof (sa));\r
 191     sa.sa_handler = SIG_IGN;\r
 192     sa.sa_flags = SA_RESTART;\r
 193 \r
 194     if (sigaction(SIGPIPE, &sa, NULL) < 0) {\r
 195         return -1;\r
 196     }\r
 197 \r
 198     memset(&sa, 0, sizeof (sa));\r
 199     sa.sa_handler = term_handler;\r
 200     sa.sa_flags = SA_RESTART;\r
 201 \r
 202     if (sigaction(SIGHUP, &sa, NULL) < 0) {\r
 203         return -1;\r
 204     }\r
 205     if (sigaction(SIGINT, &sa, NULL) < 0) {\r
 206         return -1;\r
 207     }\r
 208     if (sigaction(SIGQUIT, &sa, NULL) < 0) {\r
 209         return -1;\r
 210     }\r
 211     if (sigaction(SIGTERM, &sa, NULL) < 0) {\r
 212         return -1;\r
 213     }\r
 214 \r
 215     if (daemonize) {\r
 216         memset(&sa, 0, sizeof (sa));\r
 217         sa.sa_handler = run_handler;\r
 218 \r
 219         if (sigaction(SIGUSR1, &sa, NULL) < 0) {\r
 220             return -1;\r
 221         }\r
 222 \r
 223         memset(&sa, 0, sizeof (sa));\r
 224         sa.sa_handler = child_handler;\r
 225 \r
 226         if (sigaction(SIGCHLD, &sa, NULL) < 0) {\r
 227             return -1;\r
 228         }\r
 229     }\r
 230 \r
 231     return 0;\r
 232 }\r
 233 \r
 234 static void usage(char* whoami)\r
 235 {\r
 236     fprintf(stderr, "usage: %s [-dcxtfpvh]\n", whoami);\r
 237     fprintf(stderr, "  -d\tinstallation prefix to use.\n");\r
 238     fprintf(stderr, "  -c\tconfig file to use.\n");\r
 239     fprintf(stderr, "  -x\tXML schema catalogs to use.\n");\r
 240     fprintf(stderr, "  -t\ttest configuration file for problems.\n");\r
 241     fprintf(stderr, "  -f\tforce removal of listener socket.\n");\r
 242     fprintf(stderr, "  -F\tstay in the foreground.\n");\r
 243     fprintf(stderr, "  -p\tpid file to use.\n");\r
 244     fprintf(stderr, "  -w\tseconds to wait for successful daemonization.\n");\r
 245     fprintf(stderr, "  -v\tprint software version.\n");\r
 246     fprintf(stderr, "  -h\tprint this help message.\n");\r
 247     exit(1);\r
 248 }\r
 249 \r
 250 static int parse_args(int argc, char* argv[])\r
 251 {\r
 252     int opt;\r
 253 \r
 254     while ((opt = getopt(argc, argv, "d:c:x:p:w:fFtvh")) > 0) {\r
 255         switch (opt) {\r
 256             case 'd':\r
 257                 shar_prefix=optarg;\r
 258                 break;\r
 259             case 'c':\r
 260                 shar_config=optarg;\r
 261                 break;\r
 262             case 'x':\r
 263                 shar_schemadir=optarg;\r
 264                 break;\r
 265             case 'f':\r
 266                 unlink_socket = true;\r
 267                 break;\r
 268             case 'F':\r
 269                 daemonize = false;\r
 270                 break;\r
 271             case 't':\r
 272                 shar_checkonly=true;\r
 273                 daemonize=false;\r
 274                 break;\r
 275             case 'v':\r
 276                 shar_version=true;\r
 277                 break;\r
 278             case 'p':\r
 279                 pidfile=optarg;\r
 280                 break;\r
 281             case 'w':\r
 282                 if (optarg)\r
 283                     daemon_wait = atoi(optarg);\r
 284                 if (daemon_wait <= 0)\r
 285                     daemon_wait = 3;\r
 286                 break;\r
 287             default:\r
 288                 return -1;\r
 289         }\r
 290     }\r
 291     return 0;\r
 292 }\r
 293 \r
 294 int main(int argc, char *argv[])\r
 295 {\r
 296     if (parse_args(argc, argv) != 0)\r
 297         usage(argv[0]);\r
 298     else if (shar_version) {\r
 299         fprintf(stdout, PACKAGE_STRING"\n");\r
 300         return 0;\r
 301     }\r
 302 \r
 303     if (setup_signals() != 0)\r
 304         return -1;\r
 305 \r
 306     // initialize the shib-target library\r
 307     SPConfig& conf=SPConfig::getConfig();\r
 308     conf.setFeatures(\r
 309         SPConfig::Listener |\r
 310         SPConfig::Caching |\r
 311         SPConfig::Metadata |\r
 312         SPConfig::Trust |\r
 313         SPConfig::Credentials |\r
 314         SPConfig::AttributeResolution |\r
 315         SPConfig::Handlers |\r
 316         SPConfig::OutOfProcess |\r
 317         (shar_checkonly ? SPConfig::RequestMapping : SPConfig::Logging)\r
 318         );\r
 319     if (!conf.init(shar_schemadir, shar_prefix)) {\r
 320         fprintf(stderr, "configuration is invalid, check console for specific problems\n");\r
 321         return -1;\r
 322     }\r
 323 \r
 324     if (daemonize) {\r
 325         // We must fork() early, while we're single threaded.\r
 326         // StorageService cleanup thread is about to start.\r
 327         switch (fork()) {\r
 328             case 0:\r
 329                 break;\r
 330             case -1:\r
 331                 perror("forking");\r
 332                 exit(EXIT_FAILURE);\r
 333             default:\r
 334                 sleep(daemon_wait);\r
 335                 exit(shibd_running ? EXIT_SUCCESS : EXIT_FAILURE);\r
 336         }\r
 337     }\r
 338 \r
 339     if (!conf.instantiate(shar_config)) {\r
 340         fprintf(stderr, "configuration is invalid, check console for specific problems\n");\r
 341         conf.term();\r
 342         return -2;\r
 343     }\r
 344 \r
 345     if (shar_checkonly)\r
 346         fprintf(stderr, "overall configuration is loadable, check console for non-fatal problems\n");\r
 347     else {\r
 348         // Init the listener.\r
 349         ListenerService* listener = conf.getServiceProvider()->getListenerService();\r
 350         if (!listener->init(unlink_socket)) {\r
 351             fprintf(stderr, "listener failed to initialize\n");\r
 352             conf.term();\r
 353             return -3;\r
 354         }\r
 355 \r
 356         if (daemonize) {\r
 357             if (setsid() == -1) {\r
 358                 perror("setsid");\r
 359                 exit(EXIT_FAILURE);\r
 360             }\r
 361             if (chdir("/") == -1) {\r
 362                 perror("chdir to root");\r
 363                 exit(EXIT_FAILURE);\r
 364             }\r
 365 \r
 366             if (pidfile) {\r
 367                 FILE* pidf = fopen(pidfile, "w");\r
 368                 if (pidf) {\r
 369                     fprintf(pidf, "%d\n", getpid());\r
 370                     fclose(pidf);\r
 371                 }\r
 372                 else {\r
 373                     perror(pidfile);\r
 374                 }\r
 375             }\r
 376 \r
 377             freopen("/dev/null", "r", stdin);\r
 378             freopen("/dev/null", "w", stdout);\r
 379             freopen("/dev/null", "w", stderr);\r
 380 \r
 381             // Signal our parent that we are A-OK.\r
 382             kill(getppid(), SIGUSR1);\r
 383         }\r
 384 \r
 385         // Run the listener.\r
 386         if (!listener->run(&shibd_shutdown)) {\r
 387             fprintf(stderr, "listener failure during service\n");\r
 388             listener->term();\r
 389             conf.term();\r
 390             if (pidfile)\r
 391                 unlink(pidfile);\r
 392             return -3;\r
 393         }\r
 394         listener->term();\r
 395     }\r
 396 \r
 397     conf.term();\r
 398     if (pidfile)\r
 399         unlink(pidfile);\r
 400     return 0;\r
 401 }\r
 402 \r
 403 #endif\r