authmod.h
上传用户:s81996212
上传日期:2007-01-04
资源大小:722k
文件大小:4k
源码类别:

WEB邮件程序

开发平台:

C/C++

  1. #ifndef authmod_h
  2. #define authmod_h
  3. /*
  4. ** Copyright 1998 - 1999 Double Precision, Inc.  See COPYING for
  5. ** distribution information.
  6. */
  7. /* Common functions used by standalone authentication modules */
  8. #if HAVE_CONFIG_H
  9. #include "config.h"
  10. #endif
  11. #ifdef __cplusplus
  12. extern "C" {
  13. #endif
  14. static const char authmod_h_rcsid[]="$Id: authmod.h,v 1.5 2000/04/30 01:04:09 mrsam Exp $";
  15. /*
  16. ** Authentication modules must call authmod_init the first thing in main.
  17. */
  18. void authmod_init(
  19. int, /* argc */
  20. char **, /* argv */
  21. const char **, /* Returns service to authenticate */
  22. const char **, /* Returns authentication type */
  23. char **); /* Returns authentication data */
  24. /*
  25. ** NOTE: authmod_init does NOT return if a previous authentication module
  26. ** already succesfully authenticated the request.  authmod_init will run the
  27. ** next module automatically, hence we'll eventually wind up with the
  28. ** authentication client in the authenticated state.
  29. **
  30. ** An authentication module must call authmod_success if it accepted the
  31. ** authentication request.
  32. */
  33. void authmod_success(int, /* argc */
  34. char **, /* argv */
  35. const char *); /* authenticated_username */
  36. /*
  37. ** Standalone modules should call authmod_fail if the authentication failed.
  38. */
  39. void authmod_fail(int, /* argc */
  40. char **); /* argv */
  41. /*
  42. ** Standalone modules should call authmod_fail_completely, and if the module
  43. ** does not want any additional authentication modules to try to authenticate
  44. ** this request.  authmod_fail_completely reruns the authentication user
  45. ** process (see below).
  46. */
  47. void authmod_fail_completely();
  48. /*
  49. ** authentication clients should call authclient() the first thing in main,
  50. ** to check if the authentication succeeded.  If not, authclient terminates
  51. ** the process and reruns the authmoduser process
  52. */
  53. const char *authmodclient();
  54. /*
  55. ** authmoduser is called by authentication users as the very first thing
  56. ** in main().  It checks the environment variables and returns 0 if
  57. ** auth user was reinvoked upon authentication failure.  It returns non-0
  58. ** if this is the initial invocation of the auth user process.
  59. **
  60. ** authmoduser:
  61. **
  62. **    * checks to make sure the environment variable AUTHUSER is set, which
  63. **      should contain the full pathname to this process (can't rely on
  64. **      argv[0] all the time).  authmoduser terminates if AUTHUSER is not set.
  65. **
  66. **    * checks if the environment variable AUTHARGC is set to a non-zero
  67. **      value.  If it is, it means AUTHUSER was rerun due to an authentication
  68. **      failure, so authmoduser will return 0, after sleeping for the amount
  69. **      of time specified by the fourth argument.
  70. **
  71. **    * otherwise the environment variables AUTHARGC, AUTHARGV0, AUTHARGV1 ...
  72. **      are set to mirror the contents of the argc/argv variables, so that
  73. **      upon authentication failure $AUTHUSER can be rerun, with the same
  74. **      exact parameters.
  75. **
  76. ** The third argument to authmoduser specifies the timeout for a successful
  77. ** login.  The expiration time is also saved in the environment, and
  78. ** authmoduser will call alarm() to cause this process to die if the authmod()
  79. ** function is not called before the timer goes off.  The authmod function
  80. ** will cancel the alarm signal before running the first authentication
  81. ** module, in order to avoid arrivals of unexpected signals.
  82. **
  83. */
  84. int authmoduser(int, /* argc - as passed to main */
  85. char **, /* argv - as passed to main */
  86. unsigned, /* authentication timeout, in seconds */
  87. unsigned); /* bad authentication sleep time, in seconds */
  88. /*
  89. ** authmod is called by authentication user to attempt to authenticate
  90. ** access.  This function never returns as it execs the first authentication
  91. ** module.  The authentication module to run is taken from the argv[0]
  92. ** parameter (see below) and argc must be > 0.  This means that argc/argv
  93. ** received by main must be advanced to skip past any options on the command
  94. ** line.
  95. */
  96. #define AUTHTYPE_LOGIN "login" /* authdata is useridnpasswordn */
  97. #define AUTHTYPE_CRAMMD5 "cram-md5" /* authdata is challengenresponsen */
  98. void authmod(int, /* argc */
  99. char **, /* argv */
  100. const char *, /* service */
  101. const char *, /* authentication type */
  102. const char *); /* authentication data */
  103. void authmod_login(int,
  104. char **,
  105. const char *, /* service */
  106. const char *, /* userid */
  107. const char *); /* password */
  108. /* Magic for authdaemon */
  109. #ifdef __cplusplus
  110. }
  111. #endif
  112. #endif