Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F4191323
FunctionCausedByLines.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
8 KB
Referenced Files
None
Subscribers
None
FunctionCausedByLines.php
View Options
<?php
declare
(
strict_types
=
1
);
namespace
SecurityCheckPlugin
;
/**
* This class represents caused-by lines for a function-like:
* - Lines in genericLines are for taintedness that is added inside the function, regardless of parameters; these
* have a Taintedness object associated, while the associated links are always empty.
* - Lines in (variadic)paramSinkLines are those inside a function that EXEC the arguments. These also have a
* Taintedness object associated, and no links.
* - Lines in (variadic)paramPreservedLines are responsible for putting a parameter inside the return value. These have
* a safe Taintedness associated, and usually non-empty links.
*/
class
FunctionCausedByLines
{
/** @var CausedByLines */
private
$genericLines
;
/** @var CausedByLines[] */
private
$paramSinkLines
=
[];
/** @var CausedByLines[] */
private
$paramPreservedLines
=
[];
/** @var int|null Index of a variadic parameter, if any */
private
$variadicParamIndex
;
/** @var CausedByLines|null */
private
$variadicParamSinkLines
;
/** @var CausedByLines|null */
private
$variadicParamPreservedLines
;
public
function
__construct
()
{
$this
->
genericLines
=
new
CausedByLines
();
}
/**
* @return CausedByLines
* @suppress PhanUnreferencedPublicMethod
*/
public
function
getGenericLines
():
CausedByLines
{
return
$this
->
genericLines
;
}
/**
* @param string[] $lines
* @param Taintedness $taint
* @param MethodLinks|null $links
*/
public
function
addGenericLines
(
array
$lines
,
Taintedness
$taint
,
MethodLinks
$links
=
null
):
void
{
$this
->
genericLines
->
addLines
(
$lines
,
$taint
,
$links
);
}
/**
* @param CausedByLines $lines
*/
public
function
setGenericLines
(
CausedByLines
$lines
):
void
{
$this
->
genericLines
=
$lines
;
}
/**
* @param int $param
* @param string[] $lines
* @param Taintedness $taint
*/
public
function
addParamSinkLines
(
int
$param
,
array
$lines
,
Taintedness
$taint
):
void
{
assert
(
$param
!==
$this
->
variadicParamIndex
);
if
(
!
isset
(
$this
->
paramSinkLines
[
$param
]
)
)
{
$this
->
paramSinkLines
[
$param
]
=
new
CausedByLines
();
}
$this
->
paramSinkLines
[
$param
]->
addLines
(
$lines
,
$taint
);
}
/**
* @param int $param
* @param string[] $lines
* @param Taintedness $taint
* @param MethodLinks|null $links
*/
public
function
addParamPreservedLines
(
int
$param
,
array
$lines
,
Taintedness
$taint
,
MethodLinks
$links
=
null
):
void
{
assert
(
$param
!==
$this
->
variadicParamIndex
);
if
(
!
isset
(
$this
->
paramPreservedLines
[
$param
]
)
)
{
$this
->
paramPreservedLines
[
$param
]
=
new
CausedByLines
();
}
$this
->
paramPreservedLines
[
$param
]->
addLines
(
$lines
,
$taint
,
$links
);
}
/**
* @param int $param
* @param CausedByLines $lines
*/
public
function
setParamSinkLines
(
int
$param
,
CausedByLines
$lines
):
void
{
$this
->
paramSinkLines
[
$param
]
=
$lines
;
}
/**
* @param int $param
* @param CausedByLines $lines
*/
public
function
setParamPreservedLines
(
int
$param
,
CausedByLines
$lines
):
void
{
$this
->
paramPreservedLines
[
$param
]
=
$lines
;
}
/**
* @param int $param
* @param CausedByLines $lines
*/
public
function
setVariadicParamSinkLines
(
int
$param
,
CausedByLines
$lines
):
void
{
$this
->
variadicParamIndex
=
$param
;
$this
->
variadicParamSinkLines
=
$lines
;
}
/**
* @param int $param
* @param CausedByLines $lines
*/
public
function
setVariadicParamPreservedLines
(
int
$param
,
CausedByLines
$lines
):
void
{
$this
->
variadicParamIndex
=
$param
;
$this
->
variadicParamPreservedLines
=
$lines
;
}
/**
* @param int $param
* @param string[] $lines
* @param Taintedness $taint
*/
public
function
addVariadicParamSinkLines
(
int
$param
,
array
$lines
,
Taintedness
$taint
):
void
{
assert
(
!
isset
(
$this
->
paramSinkLines
[
$param
]
)
&&
!
isset
(
$this
->
paramPreservedLines
[
$param
]
)
);
$this
->
variadicParamIndex
=
$param
;
if
(
!
$this
->
variadicParamSinkLines
)
{
$this
->
variadicParamSinkLines
=
new
CausedByLines
();
}
$this
->
variadicParamSinkLines
->
addLines
(
$lines
,
$taint
);
}
/**
* @param int $param
* @param string[] $lines
* @param Taintedness $taint
* @param MethodLinks|null $links
*/
public
function
addVariadicParamPreservedLines
(
int
$param
,
array
$lines
,
Taintedness
$taint
,
MethodLinks
$links
=
null
):
void
{
assert
(
!
isset
(
$this
->
paramSinkLines
[
$param
]
)
&&
!
isset
(
$this
->
paramPreservedLines
[
$param
]
)
);
$this
->
variadicParamIndex
=
$param
;
if
(
!
$this
->
variadicParamPreservedLines
)
{
$this
->
variadicParamPreservedLines
=
new
CausedByLines
();
}
$this
->
variadicParamPreservedLines
->
addLines
(
$lines
,
$taint
,
$links
);
}
/**
* @param int $param
* @return CausedByLines
*/
public
function
getParamSinkLines
(
int
$param
):
CausedByLines
{
if
(
isset
(
$this
->
paramSinkLines
[
$param
]
)
)
{
return
$this
->
paramSinkLines
[
$param
];
}
if
(
$this
->
variadicParamIndex
!==
null
&&
$param
>=
$this
->
variadicParamIndex
&&
$this
->
variadicParamSinkLines
)
{
return
$this
->
variadicParamSinkLines
;
}
return
new
CausedByLines
();
}
/**
* @param int $param
* @return CausedByLines
*/
public
function
getParamPreservedLines
(
int
$param
):
CausedByLines
{
if
(
isset
(
$this
->
paramPreservedLines
[
$param
]
)
)
{
return
$this
->
paramPreservedLines
[
$param
];
}
if
(
$this
->
variadicParamIndex
!==
null
&&
$param
>=
$this
->
variadicParamIndex
&&
$this
->
variadicParamPreservedLines
)
{
return
$this
->
variadicParamPreservedLines
;
}
return
new
CausedByLines
();
}
/**
* @param FunctionCausedByLines $other
* @param FunctionTaintedness $funcTaint To check NO_OVERRIDE
*/
public
function
mergeWith
(
self
$other
,
FunctionTaintedness
$funcTaint
):
void
{
if
(
$funcTaint
->
canOverrideOverall
()
)
{
$this
->
genericLines
->
mergeWith
(
$other
->
genericLines
);
}
foreach
(
$other
->
paramSinkLines
as
$param
=>
$lines
)
{
if
(
$funcTaint
->
canOverrideNonVariadicParam
(
$param
)
)
{
if
(
isset
(
$this
->
paramSinkLines
[
$param
]
)
)
{
$this
->
paramSinkLines
[
$param
]->
mergeWith
(
$lines
);
}
else
{
$this
->
paramSinkLines
[
$param
]
=
$lines
;
}
}
}
foreach
(
$other
->
paramPreservedLines
as
$param
=>
$lines
)
{
if
(
$funcTaint
->
canOverrideNonVariadicParam
(
$param
)
)
{
if
(
isset
(
$this
->
paramPreservedLines
[
$param
]
)
)
{
$this
->
paramPreservedLines
[
$param
]->
mergeWith
(
$lines
);
}
else
{
$this
->
paramPreservedLines
[
$param
]
=
$lines
;
}
}
}
$variadicIndex
=
$other
->
variadicParamIndex
;
if
(
$variadicIndex
!==
null
&&
$funcTaint
->
canOverrideVariadicParam
()
)
{
$this
->
variadicParamIndex
=
$variadicIndex
;
$sinkVariadic
=
$other
->
variadicParamSinkLines
;
if
(
$sinkVariadic
)
{
if
(
$this
->
variadicParamSinkLines
)
{
$this
->
variadicParamSinkLines
->
mergeWith
(
$sinkVariadic
);
}
else
{
$this
->
variadicParamSinkLines
=
$sinkVariadic
;
}
}
$preserveVariadic
=
$other
->
variadicParamPreservedLines
;
if
(
$preserveVariadic
)
{
if
(
$this
->
variadicParamPreservedLines
)
{
$this
->
variadicParamPreservedLines
->
mergeWith
(
$preserveVariadic
);
}
else
{
$this
->
variadicParamPreservedLines
=
$preserveVariadic
;
}
}
}
}
public
function
__clone
()
{
$this
->
genericLines
=
clone
$this
->
genericLines
;
foreach
(
$this
->
paramSinkLines
as
$k
=>
$pLines
)
{
$this
->
paramSinkLines
[
$k
]
=
clone
$pLines
;
}
if
(
$this
->
variadicParamSinkLines
)
{
$this
->
variadicParamSinkLines
=
clone
$this
->
variadicParamSinkLines
;
}
if
(
$this
->
variadicParamPreservedLines
)
{
$this
->
variadicParamPreservedLines
=
clone
$this
->
variadicParamPreservedLines
;
}
}
/**
* @return string
*/
public
function
toString
():
string
{
$str
=
"{
\n
Generic: "
.
$this
->
genericLines
->
toDebugString
()
.
",
\n
"
;
foreach
(
$this
->
paramSinkLines
as
$par
=>
$lines
)
{
$str
.=
"$par (sink): "
.
$lines
->
toDebugString
()
.
",
\n
"
;
}
foreach
(
$this
->
paramPreservedLines
as
$par
=>
$lines
)
{
$str
.=
"$par (preserved): "
.
$lines
->
toDebugString
()
.
",
\n
"
;
}
if
(
$this
->
variadicParamSinkLines
)
{
$str
.=
"...{$this->variadicParamIndex} (sink): "
.
$this
->
variadicParamSinkLines
->
toDebugString
()
.
"
\n
"
;
}
if
(
$this
->
variadicParamPreservedLines
)
{
$str
.=
"...{$this->variadicParamIndex} (preserved): "
.
$this
->
variadicParamPreservedLines
->
toDebugString
()
.
"
\n
"
;
}
return
"$str}"
;
}
/**
* @return string
*/
public
function
__toString
():
string
{
return
$this
->
toString
();
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Aug 20 2026, 18:01 (13 w, 4 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
d7/a4/9fed8878be4569ecfda8b8d9e82d
Default Alt Text
FunctionCausedByLines.php (8 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment