File: AuthenHook.xs

package info (click to toggle)
libapache-authenhook-perl 2.00-04+pristine-7
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 240 kB
  • sloc: perl: 182; makefile: 13; sh: 11
file content (276 lines) | stat: -rwxr-xr-x 8,820 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"

#include "mod_perl.h"
#include "ap_provider.h"
#include "mod_auth.h"

static AV *providers = Nullav; /* @{$cfg->{basic}}, cached per-request   */

static int call_provider(request_rec *r, const char *type, 
                         const char *user, const char *cred, char **rethash)
{
  SV *provider = Nullsv;       /* the name of the Perl provider to call  */
  modperl_handler_t *handler;  /* the actual provider as a Perl handler  */
  AV *args = Nullav;           /* @_ to Perl handler                     */
  SV *hash = newSV(0);         /* scalar reference in @_ for Digest auth */
  SV *cfg;                     /* $cfg from directive handlers           */
  SV **svp;                    /* hash within $cfg, %{$cfg}              */
  int status;                  /* the status this function returns       */

  if (! apr_table_get(r->notes, "AUTHEN_HOOK_INIT_REQUEST")) {

    /* initialize a clean copy of the Perl provider array
     * (eg, @{$cfg->{basic}}) on each request.  because this function is
     * the sole function registered for all Perl providers, it is 
     * called multiple times per request - caching the provider array is 
     * the only way we can keep track of which Perl callbacks we've processed
     * for this request.
     * 
     * oh, and using r->notes instead of per-request cleanups helps us with
     * internal redirects, which is a nice bonus.  */

    MP_TRACE_a(MP_FUNC, 
               "Apache::AuthenHook - initializing request\n");

    /* first, get the config object ($cfg) populated by the Perl
     * directive handlers.  This returns the same object as 
     * Apache2::Module->get_config().
     */
    cfg = modperl_module_config_get_obj(aTHX_ newSVpvn("Apache::AuthenHook", 18), 
                                        r->server, r->per_dir_config);

    if (! cfg) {
      MP_TRACE_a(MP_FUNC, 
                 "Apache::AuthenHook - config object not found\n");

      return AUTH_GENERAL_ERROR;
    }

    /* isolate $cfg->{basic} */
    svp = hv_fetch((HV *)SvRV(cfg), type, strlen(type), FALSE);

    if (SvROK(*svp) && (SvTYPE(SvRV(*svp)) == SVt_PVAV)) {
      /* if $cfg->{basic} holds a reference to an array, dereference
       * and initialize provider array for this request  */

      AV *av = (AV *)SvRV(*svp);   /* temporary storage */

      providers = av_make(av_len(av)+1, AvARRAY(av));

      MP_TRACE_a(MP_FUNC, 
                 "Apache::AuthenHook - found %d providers\n", 
                 av_len(av)+1);
    }
    else {
      MP_TRACE_a(MP_FUNC, 
                 "Apache::AuthenHook - provider array not found\n");

      return AUTH_GENERAL_ERROR;
    }

    /* set the note so we don't initialize again for this (sub)request */
    apr_table_setn(r->notes, "AUTHEN_HOOK_INIT_REQUEST", "1");

  }  /* end once per-request processing */

  /* shift off the next provider from the provider array */
  provider = av_shift(providers);

  if (! SvOK(provider)) {
    MP_TRACE_a(MP_FUNC,
               "Apache::AuthenHook - provider not found\n");

    return AUTH_GENERAL_ERROR;
  }

  /* populate @_ for the callback, starting with $r */
  modperl_handler_make_args(aTHX_ &args,
                           "Apache2::RequestRec", r, NULL);

  /* now for the username and password(Basic) or realm(Digest) */
  av_push(args, newSVpv(user, 0));
  av_push(args, newSVpv(cred, 0));

  /* Digest authentication requires an extra argument - 
   * the scalar reference to be populated with the lookup hash */

  if (! strcmp(type, "digest")) {
    av_push(args, newRV_inc(hash));
  }

  /* at this point, we know which provider we're supposed to 
   * be calling and have populated the argument list.  now,
   * issue the callback using native mod_perl routines.  */

  ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                "Apache::AuthenHook - trying provider %s for %s", 
                SvPVX(provider), r->uri);

  handler = modperl_handler_new(r->pool, SvPV_nolen(provider));
  status  = modperl_callback(aTHX_ handler, r->pool, r, r->server, args);

  MP_TRACE_a(MP_FUNC, 
             "Apache::AuthenHook - provider returned %d\n", 
             status);

  /* unfortunately, modperl_callback forces the status into an HTTP_
   * status or OK, so I can't give Perl handlers meaningful access to
   * the AUTH_ constants without implementing my own callback routines.
   * this is the only real difference between the Perl and C API.
   *
   * while the switch statment in the C callback function takes care of 
   * the translation back to AUTH_ constants for us, there is still 
   * a little more work left  */

  if (status == OK && ! strcmp(type, "digest")) {

    /* for Digest we need to send the hash back for verification 
     * via mod_auth_digest */

    /* sanity checking - make sure that the scalar references a string */
    if (SvTYPE(hash) == SVt_PV) {
      *rethash = SvPV_nolen(hash);
    }
    else {
      MP_TRACE_a(MP_FUNC, 
                 "Apache::AuthenHook - returned hash not a string\n");

      status = AUTH_GENERAL_ERROR;
    }
  }
  else if (status == HTTP_INTERNAL_SERVER_ERROR) {

    /* write $@ to the error_log in the case of an error */
    modperl_errsv(aTHX_ status, r, NULL);
  }

  /* decrement args, as required by modperl_callback */
  SvREFCNT_dec((SV*)args);

  /* return whatever status the Perl provider returned */
  return status;
}

static authn_status check_password(request_rec *r, const char *user,
                                   const char *password)
{
  int status;

  MP_TRACE_a(MP_FUNC, 
             "Apache::AuthenHook - calling Basic handler\n");

  status = call_provider(r, "basic", user, password, NULL);

  /* determine which AUTH_ status we should return based on
   * what HTTP_ status the Perl provider returned.  and yes, 
   * this routine could be reused if I wanted to be less specific
   * with the log messages...  */

  switch(status) {
    case AUTH_GENERAL_ERROR:
      ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                    "Apache::AuthenHook - yikes! something bad happened!");
      ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                    "Apache::AuthenHook - try running with PerlTrace a");

      /* status is already AUTH_GENERAL_ERROR */
      break;

    case OK:
      ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                    "Apache::AuthenHook - user '%s' verified",
                    user);

      status = AUTH_GRANTED;
      break;

    case DECLINED:
      ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                    "Apache::AuthenHook - passing user '%s' to next provider",
                    user);

      status = AUTH_USER_NOT_FOUND;
      break;

    default:
      ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                    "Apache::AuthenHook - user '%s' denied",
                    user);

      status = AUTH_DENIED;
  };

  return status;
}

static authn_status get_realm_hash(request_rec *r, const char *user,
                                   const char *realm, char **rethash)
{
  int status;

  MP_TRACE_a(MP_FUNC, 
             "Apache::AuthenHook - calling Digest handler\n");

  status = call_provider(r, "digest", user, realm, &*rethash);

  switch(status) {
    case AUTH_GENERAL_ERROR:
      ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                    "Apache::AuthenHook - yikes! something bad happened!");
      ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                    "Apache::AuthenHook - try running with PerlTrace a");
      break;

    case OK:
      ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                    "Apache::AuthenHook - user '%s', hash '%s' found in realm '%s'",
                    user, *rethash, realm);

      status = AUTH_USER_FOUND;
      break;

    case DECLINED:
      ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                    "Apache::AuthenHook - passing user '%s' to next provider",
                    user);

      status = AUTH_USER_NOT_FOUND;
      break;

    default:
      ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
                    "Apache::AuthenHook - user '%s' in realm '%s' denied",
                    user, realm);

      status = AUTH_DENIED;
  };

  return status;
}

static const authn_provider authn_AAH_provider =
{
  &check_password,
  &get_realm_hash,
};

MODULE = Apache::AuthenHook    PACKAGE = Apache::AuthenHook

PROTOTYPES: DISABLE

void
register_provider(provider)
  SV *provider

  CODE:

    MP_TRACE_a(MP_FUNC, 
               "Apache::AuthenHook - registering provider %s\n", 
               SvPV_nolen(provider));

    ap_register_provider(modperl_global_get_pconf(), 
                         AUTHN_PROVIDER_GROUP, 
                         SvPV_nolen(newSVsv(provider)), "0",
                         &authn_AAH_provider);