Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7439046
KeySessionStorageTrait.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
2 KB
Referenced Files
None
Subscribers
None
KeySessionStorageTrait.php
View Options
<?php
namespace
MediaWiki\Extension\OATHAuth\HTMLForm
;
use
MediaWiki\Extension\OATHAuth\IAuthKey
;
use
MediaWiki\Extension\OATHAuth\Key\RecoveryCodeKeys
;
use
MediaWiki\Extension\OATHAuth\Key\TOTPKey
;
use
MediaWiki\Request\WebRequest
;
/**
* Helper class to display and manage recovery codes within various contexts
*/
trait
KeySessionStorageTrait
{
/** @return WebRequest */
abstract
public
function
getRequest
();
/**
* Helper function to generically track IAuthKeys in the user session
*
* @param string $keyType accepts current key names (TOTPKey, RecoveryCodeKeys)
* @return RecoveryCodeKeys|TOTPKey|null
*/
public
function
setKeyDataInSession
(
string
$keyType
,
array
$keyData
=
[]
)
{
// RecoveryCodeKeys or TOTPKey
$key
=
null
;
$sessionKey
=
$this
->
getSessionKeyName
(
$keyType
);
if
(
count
(
$keyData
)
===
0
)
{
$keyData
=
$this
->
getRequest
()->
getSession
()->
getSecret
(
$sessionKey
,
[]
)
??
[];
}
// TODO: Ideally determine key type via instanceof or ::class instead of strings
if
(
$keyType
===
'TOTPKey'
)
{
$key
=
TOTPKey
::
newFromArray
(
$keyData
);
if
(
!
$key
instanceof
TOTPKey
)
{
$key
=
TOTPKey
::
newFromRandom
();
}
}
elseif
(
$keyType
===
'RecoveryCodeKeys'
)
{
$key
=
RecoveryCodeKeys
::
newFromArray
(
$keyData
);
if
(
array_key_exists
(
'recoverycodekeys'
,
$keyData
)
&&
count
(
$keyData
[
'recoverycodekeys'
]
)
===
0
)
{
$key
->
regenerateRecoveryCodeKeys
();
}
}
if
(
$key
instanceof
IAuthKey
)
{
$this
->
getRequest
()->
getSession
()->
setSecret
(
$sessionKey
,
$key
->
jsonSerialize
()
);
}
else
{
// set the session key to empty
$this
->
getRequest
()->
getSession
()->
setSecret
(
$sessionKey
,
[]
);
}
return
$key
;
}
/**
* @return array|null
*/
public
function
getKeyDataInSession
(
string
$keyType
)
{
return
$this
->
getRequest
()->
getSession
()->
getSecret
(
$this
->
getSessionKeyName
(
$keyType
)
);
}
public
function
setKeyDataInSessionToNull
(
string
$keyType
):
void
{
$this
->
getRequest
()->
getSession
()->
setSecret
(
$this
->
getSessionKeyName
(
$keyType
),
null
);
}
private
function
getSessionKeyName
(
string
$keyType
):
string
{
return
$keyType
.
'_oathauth_key'
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 14:52 (8 h, 29 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
02/39/0422883c7381d28e5c23615a0e83
Default Alt Text
KeySessionStorageTrait.php (2 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment