-
Notifications
You must be signed in to change notification settings - Fork 0
/
.README.md.html
607 lines (589 loc) · 18 KB
/
.README.md.html
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>/home/gary/sites/xbox.gary.dev/app/vendor/codenamegary/l4-lock/.README.md.html</title>
<style type="text/css">
body {
color: #333;
font: 13px/1.4 Helvetica,arial,freesans,clean,sans-serif;
}
.markdown-body {
border: 1px solid #CACACA;
padding: 30px;
font-size: 15px;
line-height: 1.7;
word-wrap: break-word;
}
.markdown-body > *:first-child {
margin-top: 0 !important;
}
.markdown-body > *:last-child {
margin-bottom: 0 !important;
}
.markdown-body a.absent {
color: #C00;
}
.markdown-body a.anchor {
bottom: 0;
cursor: pointer;
display: block;
left: 0;
margin-left: -30px;
padding-left: 30px;
padding-right: 6px;
position: absolute;
top: 0;
}
.markdown-body a.anchor:focus {
outline: medium none;
}
.markdown-body h1, .markdown-body h2, .markdown-body h3, .markdown-body h4, .markdown-body h5, .markdown-body h6 {
cursor: text;
font-weight: bold;
line-height: 1.7;
margin: 1em 0 15px;
padding: 0;
position: relative;
}
.markdown-body h1 .octicon-link, .markdown-body h2 .octicon-link, .markdown-body h3 .octicon-link, .markdown-body h4 .octicon-link, .markdown-body h5 .octicon-link, .markdown-body h6 .octicon-link {
color: #000;
display: none;
}
.markdown-body h1:hover a.anchor, .markdown-body h2:hover a.anchor, .markdown-body h3:hover a.anchor, .markdown-body h4:hover a.anchor, .markdown-body h5:hover a.anchor, .markdown-body h6:hover a.anchor {
line-height: 1;
margin-left: -22px;
padding-left: 0;
text-decoration: none;
top: 15%;
}
.markdown-body h1:hover a.anchor .octicon-link, .markdown-body h2:hover a.anchor .octicon-link, .markdown-body h3:hover a.anchor .octicon-link, .markdown-body h4:hover a.anchor .octicon-link, .markdown-body h5:hover a.anchor .octicon-link, .markdown-body h6:hover a.anchor .octicon-link {
display: inline-block;
}
.markdown-body h1 tt, .markdown-body h1 code, .markdown-body h2 tt, .markdown-body h2 code, .markdown-body h3 tt, .markdown-body h3 code, .markdown-body h4 tt, .markdown-body h4 code, .markdown-body h5 tt, .markdown-body h5 code, .markdown-body h6 tt, .markdown-body h6 code {
font-size: inherit;
}
.markdown-body h1 {
border-bottom: 1px solid #DDD;
font-size: 2.5em;
}
.markdown-body h2 {
border-bottom: 1px solid #EEE;
font-size: 2em;
}
.markdown-body h3 {
font-size: 1.5em;
}
.markdown-body h4 {
font-size: 1.2em;
}
.markdown-body h5 {
font-size: 1em;
}
.markdown-body h6 {
color: #777;
font-size: 1em;
}
.markdown-body p, .markdown-body blockquote, .markdown-body ul, .markdown-body ol, .markdown-body dl, .markdown-body table, .markdown-body pre {
margin: 15px 0;
}
.markdown-body ul, .markdown-body ol {
padding-left: 30px;
}
.markdown-body ul.no-list, .markdown-body ol.no-list {
list-style-type: none;
padding: 0;
}
.markdown-body ul ul, .markdown-body ul ol, .markdown-body ol ol, .markdown-body ol ul {
margin-bottom: 0;
margin-top: 0;
}
.markdown-body dl {
padding: 0;
}
.markdown-body dl dt {
font-size: 14px;
font-style: italic;
font-weight: bold;
margin-top: 15px;
padding: 0;
}
.markdown-body dl dd {
margin-bottom: 15px;
padding: 0 15px;
}
.markdown-body blockquote {
border-left: 4px solid #DDD;
color: #777;
padding: 0 15px;
}
.markdown-body blockquote > *:first-child {
margin-top: 0;
}
.markdown-body blockquote > *:last-child {
margin-bottom: 0;
}
.markdown-body table {
display: block;
overflow: auto;
width: 100%;
border-collapse: collapse;
}
.markdown-body table th {
font-weight: bold;
}
.markdown-body table th, .markdown-body table td {
border: 1px solid #DDD;
padding: 6px 13px;
}
.markdown-body table tr {
background-color: #FFF;
border-top: 1px solid #CCC;
}
.markdown-body table tr:nth-child(2n) {
background-color: #F8F8F8;
}
.markdown-body img {
-moz-box-sizing: border-box;
-webkit-box-sizing: border-box;
-o-box-sizing: border-box;
box-sizing: border-box;
max-width: 100%;
border: 0px;
}
.markdown-body span.frame {
display: block;
overflow: hidden;
}
.markdown-body span.frame > span {
border: 1px solid #DDD;
display: block;
float: left;
margin: 13px 0 0;
overflow: hidden;
padding: 7px;
width: auto;
}
.markdown-body span.frame span img {
display: block;
float: left;
}
.markdown-body span.frame span span {
clear: both;
color: #333;
display: block;
padding: 5px 0 0;
}
.markdown-body span.align-center {
clear: both;
display: block;
overflow: hidden;
}
.markdown-body span.align-center > span {
display: block;
margin: 13px auto 0;
overflow: hidden;
text-align: center;
}
.markdown-body span.align-center span img {
margin: 0 auto;
text-align: center;
}
.markdown-body span.align-right {
clear: both;
display: block;
overflow: hidden;
}
.markdown-body span.align-right > span {
display: block;
margin: 13px 0 0;
overflow: hidden;
text-align: right;
}
.markdown-body span.align-right span img {
margin: 0;
text-align: right;
}
.markdown-body span.float-left {
display: block;
float: left;
margin-right: 13px;
overflow: hidden;
}
.markdown-body span.float-left span {
margin: 13px 0 0;
}
.markdown-body span.float-right {
display: block;
float: right;
margin-left: 13px;
overflow: hidden;
}
.markdown-body span.float-right > span {
display: block;
margin: 13px auto 0;
overflow: hidden;
text-align: right;
}
.markdown-body code, .markdown-body tt {
background-color: #F8F8F8;
border: 1px solid #DDD;
border-radius: 3px;
margin: 0 2px;
padding: 0 5px;
}
.markdown-body code {
white-space: nowrap;
}
.markdown-body pre > code {
border: medium none;
margin: 0;
padding: 0;
white-space: pre;
}
.markdown-body .highlight pre, .markdown-body pre {
background-color: #F8F8F8;
border: 1px solid #DDD;
border-radius: 3px;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
}
.markdown-body pre code, .markdown-body pre tt {
border: medium none;
margin: 0;
padding: 0;
word-wrap: normal;
}
pre, code, tt {
font-family: Consolas,"Liberation Mono",Courier,monospace;
font-size: 12px;
}
.highlight {
background: #FFF;
}
.highlight .k,
.highlight .o,
.highlight .cp,
.highlight .cs,
.highlight .gs,
.highlight .gu,
.highlight .kc,
.highlight .kd,
.highlight .kn,
.highlight .kp,
.highlight .kr,
.highlight .kt,
.highlight .nc,
.highlight .ne,
.highlight .nf,
.highlight .ow {
font-weight: bold;
}
.highlight .gd,
.highlight .gd .x,
.highlight .gi,
.highlight .gi .x,
.type-csharp .highlight .nf,
.type-csharp .highlight .nn {
color: #000;
}
.highlight .c,
.highlight .cm,
.highlight .c1 {
color: #998;
font-style: italic;
}
.highlight .err {
background-color: #E3D2D2;
color: #A61717;
}
.highlight .cp,
.highlight .cs {
color: #999;
}
.highlight .cs,
.highlight .ge {
font-style: italic;
}
.highlight .gd {
background-color: #FDD;
}
.highlight .gd .x {
background-color: #FAA;
}
.highlight .gr,
.highlight .gt {
color: #A00;
}
.highlight .gh {
color: #999;
}
.highlight .gi {
background-color: #DFD;
}
.highlight .gi .x {
background-color: #AFA;
}
.highlight .go {
color: #888;
}
.highlight .gp,
.highlight .nn {
color: #555;
}
.highlight .gu,
.highlight .ni {
color: #800080;
}
.highlight .kt {
color: #458;
}
.highlight .m {
color: #099;
}
.highlight .s {
color: #D14;
}
.highlight .n {
color: #333;
}
.highlight .na,
.highlight .no,
.highlight .nv,
.highlight .vc,
.highlight .vg,
.highlight .vi {
color: #008080;
}
.highlight .nb {
color: #0086B3;
}
.highlight .nc {
color: #458;
}
.highlight .ne,
.highlight .nf {
color: #900;
}
.highlight .nt {
color: #000080;
}
.highlight .w {
color: #BBB;
}
.highlight .mf,
.highlight .mh,
.highlight .mi,
.highlight .mo {
color: #099;
}
.highlight .sb,
.highlight .sc,
.highlight .sd,
.highlight .s2,
.highlight .se,
.highlight .sh,
.highlight .si,
.highlight .sx,
.highlight .s1 {
color: #D14;
}
.highlight .sr {
color: #009926;
}
.highlight .ss {
color: #990073;
}
.highlight .bp {
color: #999;
}
.highlight .il {
color: #099;
}
.highlight .gc {
background-color: #EAF2F5;
color: #999;
}
.type-csharp .highlight .k,
.type-csharp .highlight .kt {
color: #00F;
}
.type-csharp .highlight .nf {
font-weight: normal;
}
.type-csharp .highlight .nc {
color: #2B91AF;
}
.type-csharp .highlight .s,
.type-csharp .highlight .sc {
color: #A31515;
}
</style>
<script type="text/javascript">
function getDocumentScrollTop()
{
var res = document.body.scrollTop || document.documentElement.scrollTop || window.pageYOffset || 0;
// alert(res);
return res;
}
function setDocumentScrollTop(ypos)
{
window.scrollTo(0, ypos);
}
</script>
</head>
<body class="markdown-body">
<h1> <a name="user-content-lock-for-laravel" class="anchor" href="..md.html#lock-for-laravel"><span class="octicon octicon-link"></span></a>Lock for Laravel</h1>
<p>Lock is a Laravel package that allows you to very quickly and with minimal effort implement a global or selective authentication prompt while developing a site.</p>
<p>It is highly configurable and allows for very quick updates to the style and content of the login screen, users and URLs.</p>
<p><a href="login-screen.png?raw=true" target="_blank"><img src="login-screen.png?raw=true" alt="Login Screenshot" title="Login Screenshot" style="max-width:100%;" /></a></p>
<h2> <a name="user-content-security-note" class="anchor" href="..md.html#security-note"><span class="octicon octicon-link"></span></a>SECURITY NOTE</h2>
<p>Lock's primary purpose is to protect an application with a password while under development without interfering with Laravel's built-in auth drivers. It is completely distinct from the built-in Auth, allowing you to password protect all parts of your application for client access only while being developed.</p>
<p>Lock comes with a simple, config file based user => password validator for usernames and passwords. Users are stored in the config file in plain text. The validator binding is configurable and using a different method to validate users is as simple as creating your own Validator that implements the ValidatorInterface.</p>
<p>For more information, see "Custom Validators".</p>
<p>Lock requires the default Laravel session to store credentials, so it must be configured and working before use.</p>
<h3> <a name="user-content-installation" class="anchor" href="..md.html#installation"><span class="octicon octicon-link"></span></a>Installation</h3>
<p><strong>NOTE:</strong> Once installed, lock will be enabled globally by default. You can disable it through the package config.</p>
<h4> <a name="user-content-laravel-41" class="anchor" href="..md.html#laravel-41"><span class="octicon octicon-link"></span></a>Laravel 4.1</h4>
<p>Add Lock v0.2.1-beta to your composer.json.</p>
<pre><code>"require": {
"codenamegary/l4-lock": "v0.2.1-beta"
}
</code></pre>
<h4> <a name="user-content-laravel-42-or-later" class="anchor" href="..md.html#laravel-42-or-later"><span class="octicon octicon-link"></span></a>Laravel 4.2 or later</h4>
<p>Add Lock v0.2.2-beta or later to your composer.json.</p>
<pre><code>"require": {
"codenamegary/l4-lock": "v0.2.2-beta"
}
</code></pre>
<p>Composer Update</p>
<pre><code>composer update
</code></pre>
<p>Add the service provider to app/config/app.php providers array.</p>
<pre><code>'providers' => array(
...
'codenamegary\Lock\LockServiceProvider',
),
</code></pre>
<p>Publish the configuration with Artisan.</p>
<pre><code>php artisan config:publish codenamegary/l4-lock
</code></pre>
<p>Edit / add users in the config under app/config/packages/codenamegary/l4-lock/lock.php.</p>
<pre><code>/**
* Valid username and password combinations used by the default validator.
*/
'users' => array(
'client' => 'alwaysright',
),
</code></pre>
<h3> <a name="user-content-custom-validators" class="anchor" href="..md.html#custom-validators"><span class="octicon octicon-link"></span></a>Custom Validators</h3>
<p>The lock config contains a setting for the validator binding that will be used to validate usernames and passwords. The Validator interface (below) contains 1 method.</p>
<pre><code>interface ValidatorInterface {
/**
* Check the given username and password, return true if they
* are valid, false if not.
*
* @param string $username
* @param string $password
* @return bool
*/
public function valid($username, $password);
}
</code></pre>
<p>To implement your own validator, do the following.</p>
<h4> <a name="user-content-create-your-validator-class-and-implement-the-validatorinterface" class="anchor" href="..md.html#create-your-validator-class-and-implement-the-validatorinterface"><span class="octicon octicon-link"></span></a>Create your validator class and implement the ValidatorInterface.</h4>
<pre><code>class CustomLockValidator implements codenamegary\Lock\ValidatorInterface {
public function valid($username, $password)
{
... validate the username and password ...
... return true ...
... (or) ...
... return false ...
}
}
</code></pre>
<h4> <a name="user-content-register-your-validator-in-the-container" class="anchor" href="..md.html#register-your-validator-in-the-container"><span class="octicon octicon-link"></span></a>Register your validator in the container</h4>
<p>For convenience and to enable you to inject whatever dependencies you might require into your validator, bind your custom validator to the container.</p>
<p>Example:</p>
<pre><code>$app->bindShared('custom.lock.validator', function($app){
$validatorDependency1 = $app['some.dependency'];
$validatorDependency2 = $app['some.other.dependency'];
return new CustomLockValidator($validatorDependency1, $validatorDependency2);
});
</code></pre>
<h4> <a name="user-content-update-the-lock-config-to-use-the-binding-you-created" class="anchor" href="..md.html#update-the-lock-config-to-use-the-binding-you-created"><span class="octicon octicon-link"></span></a>Update the lock config to use the binding you created</h4>
<p>Inside app/config/packages/codenamegary/l4-lock/lock.php, edit the validator binding.</p>
<pre><code>/**
* This refers to the app binding for the validator class that should
* be used to validate usernames and passwords.
*/
'validator' => 'custom.lock.validator',
</code></pre>
<p>That's it! Lock will now call the valid method on your validator whenever a user tries to login.</p>
<h2> <a name="user-content-selective-auth" class="anchor" href="..md.html#selective-auth"><span class="octicon octicon-link"></span></a>Selective Auth</h2>
<p>You may wish to disable the global auth filter and instead selectively enable it for the routes you want protected.</p>
<p>First disable the global auth setting in app/config/packages/codenamegary/l4-lock/lock.php.</p>
<pre><code>/**
* Enforce the lock across the entire site. If you'd rather enable
* the lock selectively, disable this config option and apply
* the lock.auth filter on whichever routes you want locked.
*/
'global' => false,
</code></pre>
<p>Next, apply the auth filter to any route that you want to protect.</p>
<pre><code>Route::get('/', array(
'before' => 'l4-lock.auth',
function()
{
return View::make('hello')->render();
}
));
</code></pre>
<h3> <a name="user-content-global-filter-exceptions" class="anchor" href="..md.html#global-filter-exceptions"><span class="octicon octicon-link"></span></a>Global Filter Exceptions</h3>
<p>If you'd like to enable the global filter with some exceptions, just leave the global config option enabled and then add the patterns and strings you'd like to exclude to the exceptions config.</p>
<pre><code>/**
* Here you can provide a list of regex URI patterns that will be excluded
* from the global filter. These are checked against the actual URI so
* so to exclude 'http://domain/thing/*', you would add an exception
* for '/thing\/.*?/'.
*/
'exceptions' => array(
// Route exception patterns go here
),
</code></pre>
<h2> <a name="user-content-customizing-the-login-screen" class="anchor" href="..md.html#customizing-the-login-screen"><span class="octicon octicon-link"></span></a>Customizing the Login Screen</h2>
<p>Lock comes with a built-in Bootstrap3 style login screen. The config includes many settings that make it easy to change the login prompt and even use a different layout or view.</p>
<pre><code>/**
* View that will be used for the login screen and related paramters.
*/
'views' => array(
// The layout to use for the login screen
'layout' => 'l4-lock::layout',
// The section to put the login form inside the template
'section' => 'content',
// The view for the login screen
'login' => 'l4-lock::login',
// Title for the form legend
'title' => 'ACCESS RESTRICTED',
// Prompt displayed on the login form
'prompt' => 'Access to this site is restricted. Please login to continue.',
// Use this to add a foot note to the login screen if desired, you can also
// specify the name of a partial here and it will be rendered for you.
// e.g. - contact abc@xyz.com for support.
'foot-note' => false,
),
</code></pre>
<h2> <a name="user-content-customizing-urls" class="anchor" href="..md.html#customizing-urls"><span class="octicon octicon-link"></span></a>Customizing URLs</h2>
<p>By default Lock uses /lock/login and /lock/logout to provide login/out functions. These are also configurable.</p>
<pre><code>/**
* URLs that lock will respond with / use.
*/
'urls' => array(
'login' => 'lock/login',
'logout' => 'lock/logout',
),
</code></pre>
</body>
</html>