fix: AccessTokens authenticator records all accesses to database#843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 3 commits into from
Sep 19, 2023
Merged

fix: AccessTokens authenticator records all accesses to database #843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
826ca41
docs: improve comments
kenjis Sep 19, 2023
92ca399
fix: AccessTokens authenticator records all accesses
kenjis Sep 19, 2023
5e75998
docs: add UPGRADING.md
kenjis Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions UPGRADING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
# Upgrade Guide

## Version 1.0.0-beta.6 to 1.0.0-beta.7

### Install New Config AuthToken.php

A new Config file **AuthToken.php** has been introduced. Run `php spark shield:setup`
again to install it into **app/Config/**, or install it manually.

Then change the default settings as necessary. When using Token authentication,
the default value has been changed from all accesses to be recorded in the
``token_logins`` table to only accesses that fail authentication to be recorded.

## Version 1.0.0-beta.3 to 1.0.0-beta.4

### Important Password Changes
Expand Down
52 changes: 36 additions & 16 deletions src/Authentication/Authenticators/AccessTokens.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Shield\Authentication\AuthenticationException;
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
use CodeIgniter\Shield\Config\Auth;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Models\TokenLoginModel;
Expand DownExpand Up@@ -42,6 +43,8 @@ public function __construct(UserModel $provider)
*/
public function attempt(array $credentials): Result
{
$config = config('AuthToken');

/** @var IncomingRequest $request */
$request = service('request');

Expand All@@ -51,21 +54,35 @@ public function attempt(array $credentials): Result
$result = $this->check($credentials);

if (! $result->isOK()) {
// Always record a login attempt, whether success or not.
$this->loginModel->recordLoginAttempt(
self::ID_TYPE_ACCESS_TOKEN,
$credentials['token'] ?? '',
false,
$ipAddress,
$userAgent
);
if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
// Record all failed login attempts.
$this->loginModel->recordLoginAttempt(
self::ID_TYPE_ACCESS_TOKEN,
$credentials['token'] ?? '',
false,
$ipAddress,
$userAgent
);
}

return $result;
}

$user = $result->extraInfo();

if ($user->isBanned()) {
if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
// Record a banned login attempt.
$this->loginModel->recordLoginAttempt(
self::ID_TYPE_ACCESS_TOKEN,
$credentials['token'] ?? '',
false,
$ipAddress,
$userAgent,
$user->id
);
}

$this->user = null;

return new Result([
Expand All@@ -80,14 +97,17 @@ public function attempt(array $credentials): Result

$this->login($user);

$this->loginModel->recordLoginAttempt(
self::ID_TYPE_ACCESS_TOKEN,
$credentials['token'] ?? '',
true,
$ipAddress,
$userAgent,
$this->user->id
);
if ($config->recordLoginAttempt === Auth::RECORD_LOGIN_ATTEMPT_ALL) {
// Record a successful login attempt.
$this->loginModel->recordLoginAttempt(
self::ID_TYPE_ACCESS_TOKEN,
$credentials['token'] ?? '',
true,
$ipAddress,
$userAgent,
$this->user->id
);
}

return $result;
}
Expand Down
4 changes: 2 additions & 2 deletions src/Config/AuthToken.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,13 +7,13 @@
use CodeIgniter\Config\BaseConfig;

/**
* Authenticator Configuration for Token Auth and HMAC Auth
* Configuration for Token Auth and HMAC Auth
*/
class AuthToken extends BaseConfig
{
/**
* --------------------------------------------------------------------
* Record Login Attempts for Token and HMAC Authorization
* Record Login Attempts for Token Auth and HMAC Auth
* --------------------------------------------------------------------
* Specify which login attempts are recorded in the database.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Filters/TokenAuth.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class TokenAuth implements FilterInterface
{
/**
* Do whatever processing this filter needs to do.
* By default it should not return anything during
* By default, it should not return anything during
* normal execution. However, when an abnormal state
* is found, it should return an instance of
* CodeIgniter\HTTP\Response. If it does, script
Expand Down
6 changes: 3 additions & 3 deletions tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -174,7 +174,7 @@ public function testAttemptCannotFindUser(): void
$this->assertFalse($result->isOK());
$this->assertSame(lang('Auth.badToken'), $result->reason());

// A login attempt should have always been recorded
// A failed login attempt should have been recorded by default.
$this->seeInDatabase($this->tables['token_logins'], [
'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
'identifier' => 'abc123',
Expand DownExpand Up@@ -202,8 +202,8 @@ public function testAttemptSuccess(): void
$this->assertInstanceOf(AccessToken::class, $foundUser->currentAccessToken());
$this->assertSame($token->token, $foundUser->currentAccessToken()->token);

// A login attempt should have been recorded
$this->seeInDatabase($this->tables['token_logins'], [
// A successful login attempt is not recorded by default.
$this->dontSeeInDatabase($this->tables['token_logins'], [
'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
'identifier' => $token->raw_token,
'success' => 1,
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix: AccessTokens authenticator records all accesses to database#843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Sep 19, 2023
 Merged


fix: AccessTokens authenticator records all accesses to database
#843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
826ca41

docs: improve comments


kenjis Sep 19, 2023
92ca399

fix: AccessTokens authenticator records all accesses


kenjis Sep 19, 2023
5e75998

docs: add UPGRADING.md


kenjis Sep 19, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
# Upgrade Guide

## Version 1.0.0-beta.6 to 1.0.0-beta.7

### Install New Config AuthToken.php

A new Config file **AuthToken.php** has been introduced. Run `php spark shield:setup`
again to install it into **app/Config/**, or install it manually.

Then change the default settings as necessary. When using Token authentication,
the default value has been changed from all accesses to be recorded in the
``token_logins`` table to only accesses that fail authentication to be recorded.

## Version 1.0.0-beta.3 to 1.0.0-beta.4

### Important Password Changes
Expand Down

52 changes: 36 additions & 16 deletions
src/Authentication/Authenticators/AccessTokens.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Shield\Authentication\AuthenticationException;
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
use CodeIgniter\Shield\Config\Auth;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Models\TokenLoginModel;
Expand DownExpand Up@@ -42,6 +43,8 @@ public function __construct(UserModel $provider)
 */
 public function attempt(array $credentials): Result
 {
 $config = config('AuthToken');

 /** @var IncomingRequest $request */
 $request = service('request');

Expand All@@ -51,21 +54,35 @@ public function attempt(array $credentials): Result
 $result = $this->check($credentials);

 if (! $result->isOK()) {
 // Always record a login attempt, whether success or not.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record all failed login attempts.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 }

 return $result;
 }

 $user = $result->extraInfo();

 if ($user->isBanned()) {
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record a banned login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent,
 $user->id
 );
 }

 $this->user = null;

 return new Result([
Expand All@@ -80,14 +97,17 @@ public function attempt(array $credentials): Result

 $this->login($user);

 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 if ($config->recordLoginAttempt === Auth::RECORD_LOGIN_ATTEMPT_ALL) {
 // Record a successful login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 }

 return $result;
 }
Expand Down

4 changes: 2 additions & 2 deletions
src/Config/AuthToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,13 +7,13 @@
use CodeIgniter\Config\BaseConfig;

/**
 * Authenticator Configuration for Token Auth and HMAC Auth
 * Configuration for Token Auth and HMAC Auth
 */
class AuthToken extends BaseConfig
{
 /**
 * --------------------------------------------------------------------
 * Record Login Attempts for Token and HMAC Authorization
 * Record Login Attempts for Token Auth and HMAC Auth
 * --------------------------------------------------------------------
 * Specify which login attempts are recorded in the database.
 *
Expand Down

2 changes: 1 addition & 1 deletion
src/Filters/TokenAuth.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class TokenAuth implements FilterInterface
{
 /**
 * Do whatever processing this filter needs to do.
 * By default it should not return anything during
 * By default, it should not return anything during
 * normal execution. However, when an abnormal state
 * is found, it should return an instance of
 * CodeIgniter\HTTP\Response. If it does, script
Expand Down

6 changes: 3 additions & 3 deletions
tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -174,7 +174,7 @@ public function testAttemptCannotFindUser(): void
 $this->assertFalse($result->isOK());
 $this->assertSame(lang('Auth.badToken'), $result->reason());

 // A login attempt should have always been recorded
 // A failed login attempt should have been recorded by default.
 $this->seeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => 'abc123',
Expand DownExpand Up@@ -202,8 +202,8 @@ public function testAttemptSuccess(): void
 $this->assertInstanceOf(AccessToken::class, $foundUser->currentAccessToken());
 $this->assertSame($token->token, $foundUser->currentAccessToken()->token);

 // A login attempt should have been recorded
 $this->seeInDatabase($this->tables['token_logins'], [
 // A successful login attempt is not recorded by default.
 $this->dontSeeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => $token->raw_token,
 'success' => 1,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: AccessTokens authenticator records all accesses to database#843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Sep 19, 2023
 Merged


fix: AccessTokens authenticator records all accesses to database
#843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
826ca41

docs: improve comments


kenjis Sep 19, 2023
92ca399

fix: AccessTokens authenticator records all accesses


kenjis Sep 19, 2023
5e75998

docs: add UPGRADING.md


kenjis Sep 19, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
# Upgrade Guide

## Version 1.0.0-beta.6 to 1.0.0-beta.7

### Install New Config AuthToken.php

A new Config file **AuthToken.php** has been introduced. Run `php spark shield:setup`
again to install it into **app/Config/**, or install it manually.

Then change the default settings as necessary. When using Token authentication,
the default value has been changed from all accesses to be recorded in the
``token_logins`` table to only accesses that fail authentication to be recorded.

## Version 1.0.0-beta.3 to 1.0.0-beta.4

### Important Password Changes
Expand Down

52 changes: 36 additions & 16 deletions
src/Authentication/Authenticators/AccessTokens.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Shield\Authentication\AuthenticationException;
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
use CodeIgniter\Shield\Config\Auth;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Models\TokenLoginModel;
Expand DownExpand Up@@ -42,6 +43,8 @@ public function __construct(UserModel $provider)
 */
 public function attempt(array $credentials): Result
 {
 $config = config('AuthToken');

 /** @var IncomingRequest $request */
 $request = service('request');

Expand All@@ -51,21 +54,35 @@ public function attempt(array $credentials): Result
 $result = $this->check($credentials);

 if (! $result->isOK()) {
 // Always record a login attempt, whether success or not.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record all failed login attempts.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 }

 return $result;
 }

 $user = $result->extraInfo();

 if ($user->isBanned()) {
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record a banned login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent,
 $user->id
 );
 }

 $this->user = null;

 return new Result([
Expand All@@ -80,14 +97,17 @@ public function attempt(array $credentials): Result

 $this->login($user);

 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 if ($config->recordLoginAttempt === Auth::RECORD_LOGIN_ATTEMPT_ALL) {
 // Record a successful login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 }

 return $result;
 }
Expand Down

4 changes: 2 additions & 2 deletions
src/Config/AuthToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,13 +7,13 @@
use CodeIgniter\Config\BaseConfig;

/**
 * Authenticator Configuration for Token Auth and HMAC Auth
 * Configuration for Token Auth and HMAC Auth
 */
class AuthToken extends BaseConfig
{
 /**
 * --------------------------------------------------------------------
 * Record Login Attempts for Token and HMAC Authorization
 * Record Login Attempts for Token Auth and HMAC Auth
 * --------------------------------------------------------------------
 * Specify which login attempts are recorded in the database.
 *
Expand Down

2 changes: 1 addition & 1 deletion
src/Filters/TokenAuth.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class TokenAuth implements FilterInterface
{
 /**
 * Do whatever processing this filter needs to do.
 * By default it should not return anything during
 * By default, it should not return anything during
 * normal execution. However, when an abnormal state
 * is found, it should return an instance of
 * CodeIgniter\HTTP\Response. If it does, script
Expand Down

6 changes: 3 additions & 3 deletions
tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -174,7 +174,7 @@ public function testAttemptCannotFindUser(): void
 $this->assertFalse($result->isOK());
 $this->assertSame(lang('Auth.badToken'), $result->reason());

 // A login attempt should have always been recorded
 // A failed login attempt should have been recorded by default.
 $this->seeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => 'abc123',
Expand DownExpand Up@@ -202,8 +202,8 @@ public function testAttemptSuccess(): void
 $this->assertInstanceOf(AccessToken::class, $foundUser->currentAccessToken());
 $this->assertSame($token->token, $foundUser->currentAccessToken()->token);

 // A login attempt should have been recorded
 $this->seeInDatabase($this->tables['token_logins'], [
 // A successful login attempt is not recorded by default.
 $this->dontSeeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => $token->raw_token,
 'success' => 1,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: AccessTokens authenticator records all accesses to database#843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Sep 19, 2023
 Merged


fix: AccessTokens authenticator records all accesses to database
#843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
826ca41

docs: improve comments


kenjis Sep 19, 2023
92ca399

fix: AccessTokens authenticator records all accesses


kenjis Sep 19, 2023
5e75998

docs: add UPGRADING.md


kenjis Sep 19, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
# Upgrade Guide

## Version 1.0.0-beta.6 to 1.0.0-beta.7

### Install New Config AuthToken.php

A new Config file **AuthToken.php** has been introduced. Run `php spark shield:setup`
again to install it into **app/Config/**, or install it manually.

Then change the default settings as necessary. When using Token authentication,
the default value has been changed from all accesses to be recorded in the
``token_logins`` table to only accesses that fail authentication to be recorded.

## Version 1.0.0-beta.3 to 1.0.0-beta.4

### Important Password Changes
Expand Down

52 changes: 36 additions & 16 deletions
src/Authentication/Authenticators/AccessTokens.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Shield\Authentication\AuthenticationException;
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
use CodeIgniter\Shield\Config\Auth;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Models\TokenLoginModel;
Expand DownExpand Up@@ -42,6 +43,8 @@ public function __construct(UserModel $provider)
 */
 public function attempt(array $credentials): Result
 {
 $config = config('AuthToken');

 /** @var IncomingRequest $request */
 $request = service('request');

Expand All@@ -51,21 +54,35 @@ public function attempt(array $credentials): Result
 $result = $this->check($credentials);

 if (! $result->isOK()) {
 // Always record a login attempt, whether success or not.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record all failed login attempts.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 }

 return $result;
 }

 $user = $result->extraInfo();

 if ($user->isBanned()) {
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record a banned login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent,
 $user->id
 );
 }

 $this->user = null;

 return new Result([
Expand All@@ -80,14 +97,17 @@ public function attempt(array $credentials): Result

 $this->login($user);

 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 if ($config->recordLoginAttempt === Auth::RECORD_LOGIN_ATTEMPT_ALL) {
 // Record a successful login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 }

 return $result;
 }
Expand Down

4 changes: 2 additions & 2 deletions
src/Config/AuthToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,13 +7,13 @@
use CodeIgniter\Config\BaseConfig;

/**
 * Authenticator Configuration for Token Auth and HMAC Auth
 * Configuration for Token Auth and HMAC Auth
 */
class AuthToken extends BaseConfig
{
 /**
 * --------------------------------------------------------------------
 * Record Login Attempts for Token and HMAC Authorization
 * Record Login Attempts for Token Auth and HMAC Auth
 * --------------------------------------------------------------------
 * Specify which login attempts are recorded in the database.
 *
Expand Down

2 changes: 1 addition & 1 deletion
src/Filters/TokenAuth.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class TokenAuth implements FilterInterface
{
 /**
 * Do whatever processing this filter needs to do.
 * By default it should not return anything during
 * By default, it should not return anything during
 * normal execution. However, when an abnormal state
 * is found, it should return an instance of
 * CodeIgniter\HTTP\Response. If it does, script
Expand Down

6 changes: 3 additions & 3 deletions
tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -174,7 +174,7 @@ public function testAttemptCannotFindUser(): void
 $this->assertFalse($result->isOK());
 $this->assertSame(lang('Auth.badToken'), $result->reason());

 // A login attempt should have always been recorded
 // A failed login attempt should have been recorded by default.
 $this->seeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => 'abc123',
Expand DownExpand Up@@ -202,8 +202,8 @@ public function testAttemptSuccess(): void
 $this->assertInstanceOf(AccessToken::class, $foundUser->currentAccessToken());
 $this->assertSame($token->token, $foundUser->currentAccessToken()->token);

 // A login attempt should have been recorded
 $this->seeInDatabase($this->tables['token_logins'], [
 // A successful login attempt is not recorded by default.
 $this->dontSeeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => $token->raw_token,
 'success' => 1,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix: AccessTokens authenticator records all accesses to database#843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Sep 19, 2023
 Merged


fix: AccessTokens authenticator records all accesses to database
#843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
826ca41

docs: improve comments


kenjis Sep 19, 2023
92ca399

fix: AccessTokens authenticator records all accesses


kenjis Sep 19, 2023
5e75998

docs: add UPGRADING.md


kenjis Sep 19, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
# Upgrade Guide

## Version 1.0.0-beta.6 to 1.0.0-beta.7

### Install New Config AuthToken.php

A new Config file **AuthToken.php** has been introduced. Run `php spark shield:setup`
again to install it into **app/Config/**, or install it manually.

Then change the default settings as necessary. When using Token authentication,
the default value has been changed from all accesses to be recorded in the
``token_logins`` table to only accesses that fail authentication to be recorded.

## Version 1.0.0-beta.3 to 1.0.0-beta.4

### Important Password Changes
Expand Down

52 changes: 36 additions & 16 deletions
src/Authentication/Authenticators/AccessTokens.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Shield\Authentication\AuthenticationException;
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
use CodeIgniter\Shield\Config\Auth;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Models\TokenLoginModel;
Expand DownExpand Up@@ -42,6 +43,8 @@ public function __construct(UserModel $provider)
 */
 public function attempt(array $credentials): Result
 {
 $config = config('AuthToken');

 /** @var IncomingRequest $request */
 $request = service('request');

Expand All@@ -51,21 +54,35 @@ public function attempt(array $credentials): Result
 $result = $this->check($credentials);

 if (! $result->isOK()) {
 // Always record a login attempt, whether success or not.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record all failed login attempts.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 }

 return $result;
 }

 $user = $result->extraInfo();

 if ($user->isBanned()) {
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record a banned login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent,
 $user->id
 );
 }

 $this->user = null;

 return new Result([
Expand All@@ -80,14 +97,17 @@ public function attempt(array $credentials): Result

 $this->login($user);

 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 if ($config->recordLoginAttempt === Auth::RECORD_LOGIN_ATTEMPT_ALL) {
 // Record a successful login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 }

 return $result;
 }
Expand Down

4 changes: 2 additions & 2 deletions
src/Config/AuthToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,13 +7,13 @@
use CodeIgniter\Config\BaseConfig;

/**
 * Authenticator Configuration for Token Auth and HMAC Auth
 * Configuration for Token Auth and HMAC Auth
 */
class AuthToken extends BaseConfig
{
 /**
 * --------------------------------------------------------------------
 * Record Login Attempts for Token and HMAC Authorization
 * Record Login Attempts for Token Auth and HMAC Auth
 * --------------------------------------------------------------------
 * Specify which login attempts are recorded in the database.
 *
Expand Down

2 changes: 1 addition & 1 deletion
src/Filters/TokenAuth.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class TokenAuth implements FilterInterface
{
 /**
 * Do whatever processing this filter needs to do.
 * By default it should not return anything during
 * By default, it should not return anything during
 * normal execution. However, when an abnormal state
 * is found, it should return an instance of
 * CodeIgniter\HTTP\Response. If it does, script
Expand Down

6 changes: 3 additions & 3 deletions
tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -174,7 +174,7 @@ public function testAttemptCannotFindUser(): void
 $this->assertFalse($result->isOK());
 $this->assertSame(lang('Auth.badToken'), $result->reason());

 // A login attempt should have always been recorded
 // A failed login attempt should have been recorded by default.
 $this->seeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => 'abc123',
Expand DownExpand Up@@ -202,8 +202,8 @@ public function testAttemptSuccess(): void
 $this->assertInstanceOf(AccessToken::class, $foundUser->currentAccessToken());
 $this->assertSame($token->token, $foundUser->currentAccessToken()->token);

 // A login attempt should have been recorded
 $this->seeInDatabase($this->tables['token_logins'], [
 // A successful login attempt is not recorded by default.
 $this->dontSeeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => $token->raw_token,
 'success' => 1,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: AccessTokens authenticator records all accesses to database#843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Sep 19, 2023
 Merged


fix: AccessTokens authenticator records all accesses to database
#843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
826ca41

docs: improve comments


kenjis Sep 19, 2023
92ca399

fix: AccessTokens authenticator records all accesses


kenjis Sep 19, 2023
5e75998

docs: add UPGRADING.md


kenjis Sep 19, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
# Upgrade Guide

## Version 1.0.0-beta.6 to 1.0.0-beta.7

### Install New Config AuthToken.php

A new Config file **AuthToken.php** has been introduced. Run `php spark shield:setup`
again to install it into **app/Config/**, or install it manually.

Then change the default settings as necessary. When using Token authentication,
the default value has been changed from all accesses to be recorded in the
``token_logins`` table to only accesses that fail authentication to be recorded.

## Version 1.0.0-beta.3 to 1.0.0-beta.4

### Important Password Changes
Expand Down

52 changes: 36 additions & 16 deletions
src/Authentication/Authenticators/AccessTokens.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Shield\Authentication\AuthenticationException;
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
use CodeIgniter\Shield\Config\Auth;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Models\TokenLoginModel;
Expand DownExpand Up@@ -42,6 +43,8 @@ public function __construct(UserModel $provider)
 */
 public function attempt(array $credentials): Result
 {
 $config = config('AuthToken');

 /** @var IncomingRequest $request */
 $request = service('request');

Expand All@@ -51,21 +54,35 @@ public function attempt(array $credentials): Result
 $result = $this->check($credentials);

 if (! $result->isOK()) {
 // Always record a login attempt, whether success or not.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record all failed login attempts.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 }

 return $result;
 }

 $user = $result->extraInfo();

 if ($user->isBanned()) {
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record a banned login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent,
 $user->id
 );
 }

 $this->user = null;

 return new Result([
Expand All@@ -80,14 +97,17 @@ public function attempt(array $credentials): Result

 $this->login($user);

 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 if ($config->recordLoginAttempt === Auth::RECORD_LOGIN_ATTEMPT_ALL) {
 // Record a successful login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 }

 return $result;
 }
Expand Down

4 changes: 2 additions & 2 deletions
src/Config/AuthToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,13 +7,13 @@
use CodeIgniter\Config\BaseConfig;

/**
 * Authenticator Configuration for Token Auth and HMAC Auth
 * Configuration for Token Auth and HMAC Auth
 */
class AuthToken extends BaseConfig
{
 /**
 * --------------------------------------------------------------------
 * Record Login Attempts for Token and HMAC Authorization
 * Record Login Attempts for Token Auth and HMAC Auth
 * --------------------------------------------------------------------
 * Specify which login attempts are recorded in the database.
 *
Expand Down

2 changes: 1 addition & 1 deletion
src/Filters/TokenAuth.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class TokenAuth implements FilterInterface
{
 /**
 * Do whatever processing this filter needs to do.
 * By default it should not return anything during
 * By default, it should not return anything during
 * normal execution. However, when an abnormal state
 * is found, it should return an instance of
 * CodeIgniter\HTTP\Response. If it does, script
Expand Down

6 changes: 3 additions & 3 deletions
tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -174,7 +174,7 @@ public function testAttemptCannotFindUser(): void
 $this->assertFalse($result->isOK());
 $this->assertSame(lang('Auth.badToken'), $result->reason());

 // A login attempt should have always been recorded
 // A failed login attempt should have been recorded by default.
 $this->seeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => 'abc123',
Expand DownExpand Up@@ -202,8 +202,8 @@ public function testAttemptSuccess(): void
 $this->assertInstanceOf(AccessToken::class, $foundUser->currentAccessToken());
 $this->assertSame($token->token, $foundUser->currentAccessToken()->token);

 // A login attempt should have been recorded
 $this->seeInDatabase($this->tables['token_logins'], [
 // A successful login attempt is not recorded by default.
 $this->dontSeeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => $token->raw_token,
 'success' => 1,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: AccessTokens authenticator records all accesses to database#843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Sep 19, 2023
 Merged


fix: AccessTokens authenticator records all accesses to database
#843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
826ca41

docs: improve comments


kenjis Sep 19, 2023
92ca399

fix: AccessTokens authenticator records all accesses


kenjis Sep 19, 2023
5e75998

docs: add UPGRADING.md


kenjis Sep 19, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
# Upgrade Guide

## Version 1.0.0-beta.6 to 1.0.0-beta.7

### Install New Config AuthToken.php

A new Config file **AuthToken.php** has been introduced. Run `php spark shield:setup`
again to install it into **app/Config/**, or install it manually.

Then change the default settings as necessary. When using Token authentication,
the default value has been changed from all accesses to be recorded in the
``token_logins`` table to only accesses that fail authentication to be recorded.

## Version 1.0.0-beta.3 to 1.0.0-beta.4

### Important Password Changes
Expand Down

52 changes: 36 additions & 16 deletions
src/Authentication/Authenticators/AccessTokens.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Shield\Authentication\AuthenticationException;
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
use CodeIgniter\Shield\Config\Auth;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Models\TokenLoginModel;
Expand DownExpand Up@@ -42,6 +43,8 @@ public function __construct(UserModel $provider)
 */
 public function attempt(array $credentials): Result
 {
 $config = config('AuthToken');

 /** @var IncomingRequest $request */
 $request = service('request');

Expand All@@ -51,21 +54,35 @@ public function attempt(array $credentials): Result
 $result = $this->check($credentials);

 if (! $result->isOK()) {
 // Always record a login attempt, whether success or not.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record all failed login attempts.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 }

 return $result;
 }

 $user = $result->extraInfo();

 if ($user->isBanned()) {
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record a banned login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent,
 $user->id
 );
 }

 $this->user = null;

 return new Result([
Expand All@@ -80,14 +97,17 @@ public function attempt(array $credentials): Result

 $this->login($user);

 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 if ($config->recordLoginAttempt === Auth::RECORD_LOGIN_ATTEMPT_ALL) {
 // Record a successful login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 }

 return $result;
 }
Expand Down

4 changes: 2 additions & 2 deletions
src/Config/AuthToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,13 +7,13 @@
use CodeIgniter\Config\BaseConfig;

/**
 * Authenticator Configuration for Token Auth and HMAC Auth
 * Configuration for Token Auth and HMAC Auth
 */
class AuthToken extends BaseConfig
{
 /**
 * --------------------------------------------------------------------
 * Record Login Attempts for Token and HMAC Authorization
 * Record Login Attempts for Token Auth and HMAC Auth
 * --------------------------------------------------------------------
 * Specify which login attempts are recorded in the database.
 *
Expand Down

2 changes: 1 addition & 1 deletion
src/Filters/TokenAuth.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class TokenAuth implements FilterInterface
{
 /**
 * Do whatever processing this filter needs to do.
 * By default it should not return anything during
 * By default, it should not return anything during
 * normal execution. However, when an abnormal state
 * is found, it should return an instance of
 * CodeIgniter\HTTP\Response. If it does, script
Expand Down

6 changes: 3 additions & 3 deletions
tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -174,7 +174,7 @@ public function testAttemptCannotFindUser(): void
 $this->assertFalse($result->isOK());
 $this->assertSame(lang('Auth.badToken'), $result->reason());

 // A login attempt should have always been recorded
 // A failed login attempt should have been recorded by default.
 $this->seeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => 'abc123',
Expand DownExpand Up@@ -202,8 +202,8 @@ public function testAttemptSuccess(): void
 $this->assertInstanceOf(AccessToken::class, $foundUser->currentAccessToken());
 $this->assertSame($token->token, $foundUser->currentAccessToken()->token);

 // A login attempt should have been recorded
 $this->seeInDatabase($this->tables['token_logins'], [
 // A successful login attempt is not recorded by default.
 $this->dontSeeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => $token->raw_token,
 'success' => 1,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix: AccessTokens authenticator records all accesses to database#843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Sep 19, 2023
 Merged


fix: AccessTokens authenticator records all accesses to database
#843
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
826ca41

docs: improve comments


kenjis Sep 19, 2023
92ca399

fix: AccessTokens authenticator records all accesses


kenjis Sep 19, 2023
5e75998

docs: add UPGRADING.md


kenjis Sep 19, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
# Upgrade Guide

## Version 1.0.0-beta.6 to 1.0.0-beta.7

### Install New Config AuthToken.php

A new Config file **AuthToken.php** has been introduced. Run `php spark shield:setup`
again to install it into **app/Config/**, or install it manually.

Then change the default settings as necessary. When using Token authentication,
the default value has been changed from all accesses to be recorded in the
``token_logins`` table to only accesses that fail authentication to be recorded.

## Version 1.0.0-beta.3 to 1.0.0-beta.4

### Important Password Changes
Expand Down

52 changes: 36 additions & 16 deletions
src/Authentication/Authenticators/AccessTokens.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Shield\Authentication\AuthenticationException;
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
use CodeIgniter\Shield\Config\Auth;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Models\TokenLoginModel;
Expand DownExpand Up@@ -42,6 +43,8 @@ public function __construct(UserModel $provider)
 */
 public function attempt(array $credentials): Result
 {
 $config = config('AuthToken');

 /** @var IncomingRequest $request */
 $request = service('request');

Expand All@@ -51,21 +54,35 @@ public function attempt(array $credentials): Result
 $result = $this->check($credentials);

 if (! $result->isOK()) {
 // Always record a login attempt, whether success or not.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record all failed login attempts.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent
 );
 }

 return $result;
 }

 $user = $result->extraInfo();

 if ($user->isBanned()) {
 if ($config->recordLoginAttempt >= Auth::RECORD_LOGIN_ATTEMPT_FAILURE) {
 // Record a banned login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 false,
 $ipAddress,
 $userAgent,
 $user->id
 );
 }

 $this->user = null;

 return new Result([
Expand All@@ -80,14 +97,17 @@ public function attempt(array $credentials): Result

 $this->login($user);

 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 if ($config->recordLoginAttempt === Auth::RECORD_LOGIN_ATTEMPT_ALL) {
 // Record a successful login attempt.
 $this->loginModel->recordLoginAttempt(
 self::ID_TYPE_ACCESS_TOKEN,
 $credentials['token'] ?? '',
 true,
 $ipAddress,
 $userAgent,
 $this->user->id
 );
 }

 return $result;
 }
Expand Down

4 changes: 2 additions & 2 deletions
src/Config/AuthToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,13 +7,13 @@
use CodeIgniter\Config\BaseConfig;

/**
 * Authenticator Configuration for Token Auth and HMAC Auth
 * Configuration for Token Auth and HMAC Auth
 */
class AuthToken extends BaseConfig
{
 /**
 * --------------------------------------------------------------------
 * Record Login Attempts for Token and HMAC Authorization
 * Record Login Attempts for Token Auth and HMAC Auth
 * --------------------------------------------------------------------
 * Specify which login attempts are recorded in the database.
 *
Expand Down

2 changes: 1 addition & 1 deletion
src/Filters/TokenAuth.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class TokenAuth implements FilterInterface
{
 /**
 * Do whatever processing this filter needs to do.
 * By default it should not return anything during
 * By default, it should not return anything during
 * normal execution. However, when an abnormal state
 * is found, it should return an instance of
 * CodeIgniter\HTTP\Response. If it does, script
Expand Down

6 changes: 3 additions & 3 deletions
tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -174,7 +174,7 @@ public function testAttemptCannotFindUser(): void
 $this->assertFalse($result->isOK());
 $this->assertSame(lang('Auth.badToken'), $result->reason());

 // A login attempt should have always been recorded
 // A failed login attempt should have been recorded by default.
 $this->seeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => 'abc123',
Expand DownExpand Up@@ -202,8 +202,8 @@ public function testAttemptSuccess(): void
 $this->assertInstanceOf(AccessToken::class, $foundUser->currentAccessToken());
 $this->assertSame($token->token, $foundUser->currentAccessToken()->token);

 // A login attempt should have been recorded
 $this->seeInDatabase($this->tables['token_logins'], [
 // A successful login attempt is not recorded by default.
 $this->dontSeeInDatabase($this->tables['token_logins'], [
 'id_type' => AccessTokens::ID_TYPE_ACCESS_TOKEN,
 'identifier' => $token->raw_token,
 'success' => 1,
Expand Down