Page MenuHomeWickedGov Phorge
Files F4102647

TaintednessAccessorsTrait.php
No OneTemporary
Actions

Size
7 KB
Referenced Files
None
Subscribers
None

TaintednessAccessorsTrait.php
View Options

<?php declare( strict_types=1 );
namespace SecurityCheckPlugin;
use Phan\Language\Element\FunctionInterface;
use Phan\Language\Element\PassByReferenceVariable;
use Phan\Language\Element\TypedElementInterface;
/**
* Accessors to read and write taintedness props stored inside phan objects. This trait exists to avoid duplicating
* dynamic property names, to have better type inference, to enable phan checks for undeclared props on the other
* files, to keep track of props usage etc.
* @phan-file-suppress PhanUndeclaredProperty
*/
trait TaintednessAccessorsTrait {
/**
* @param TypedElementInterface $element
* @return Taintedness|null
*/
protected static function getTaintednessRaw( TypedElementInterface $element ): ?Taintedness {
return $element->taintedness ?? null;
}
/**
* @param TypedElementInterface $element
* @return Taintedness|null
* @suppress PhanUnreferencedProtectedMethod False positive
*/
protected static function getTaintednessRawClone( TypedElementInterface $element ): ?Taintedness {
// Performance: use isset(), not property_exists()
return isset( $element->taintedness ) ? clone $element->taintedness : null;
}
/**
* @param TypedElementInterface $element
* @param Taintedness $taintedness
*/
protected static function setTaintednessRaw( TypedElementInterface $element, Taintedness $taintedness ): void {
$element->taintedness = $taintedness;
if ( $element instanceof PassByReferenceVariable ) {
self::setTaintednessRef( $element->getElement(), $taintedness );
}
}
/**
* @param TypedElementInterface $element
* @return CausedByLines|null
*/
protected static function getCausedByRaw( TypedElementInterface $element ): ?CausedByLines {
return $element->taintedOriginalError ?? null;
}
/**
* @param TypedElementInterface $element
* @return CausedByLines
*/
protected static function getCausedByRawCloneOrEmpty( TypedElementInterface $element ): CausedByLines {
return isset( $element->taintedOriginalError ) ? clone $element->taintedOriginalError : new CausedByLines();
}
/**
* @param FunctionInterface $func
* @return FunctionCausedByLines
*/
protected static function getFuncCausedByRawCloneOrEmpty( FunctionInterface $func ): FunctionCausedByLines {
return isset( $func->funcTaintedOriginalError )
? clone $func->funcTaintedOriginalError
: new FunctionCausedByLines();
}
/**
* @param TypedElementInterface $element
* @param CausedByLines $lines
*/
protected static function setCausedByRaw( TypedElementInterface $element, CausedByLines $lines ): void {
$element->taintedOriginalError = $lines;
if ( $element instanceof PassByReferenceVariable ) {
$curCausedBy = self::getCausedByRaw( $element->getElement() );
$newCausedBy = $curCausedBy ? $curCausedBy->asMergedWith( $lines ) : $lines;
self::setCausedByRaw( $element->getElement(), $newCausedBy );
}
}
/**
* @param FunctionInterface $func
* @param FunctionCausedByLines $lines
*/
protected static function setFuncCausedByRaw( FunctionInterface $func, FunctionCausedByLines $lines ): void {
$func->funcTaintedOriginalError = $lines;
}
/**
* @note This doesn't return a clone
*
* @param TypedElementInterface $element
* @return MethodLinks|null
*/
protected static function getMethodLinks( TypedElementInterface $element ): ?MethodLinks {
return $element->taintedMethodLinks ?? null;
}
/**
* @param TypedElementInterface $element
* @return MethodLinks
*/
protected static function getMethodLinksCloneOrEmpty( TypedElementInterface $element ): MethodLinks {
// Performance: use isset(), not property_exists()
return isset( $element->taintedMethodLinks ) ? clone $element->taintedMethodLinks : new MethodLinks();
}
/**
* @param TypedElementInterface $element
* @param MethodLinks $links
*/
protected static function setMethodLinks( TypedElementInterface $element, MethodLinks $links ): void {
$element->taintedMethodLinks = $links;
if ( $element instanceof PassByReferenceVariable ) {
$element->getElement()->taintedMethodLinksRef = $links;
}
}
/**
* @param TypedElementInterface $element
* @return MethodLinks|null
*/
protected static function getMethodLinksRef( TypedElementInterface $element ): ?MethodLinks {
return $element->taintedMethodLinksRef ?? null;
}
/**
* @param FunctionInterface $func
* @param int $index
* @return VarLinksSet|null
*/
protected static function getVarLinks( FunctionInterface $func, int $index ): ?VarLinksSet {
return $func->taintedVarLinks[$index] ?? null;
}
/**
* @param TypedElementInterface $element
* @param int $arg
*/
protected static function ensureVarLinksForArgExist( TypedElementInterface $element, int $arg ): void {
$element->taintedVarLinks ??= [];
$element->taintedVarLinks[$arg] ??= new VarLinksSet;
}
/**
* @param TypedElementInterface $element
* @return Taintedness|null
*/
protected static function getTaintednessRef( TypedElementInterface $element ): ?Taintedness {
// Performance: use isset(), not property_exists()
return isset( $element->taintednessRef ) ? clone $element->taintednessRef : null;
}
/**
* @param TypedElementInterface $element
* @param Taintedness $taintedness
*/
protected static function setTaintednessRef( TypedElementInterface $element, Taintedness $taintedness ): void {
$element->taintednessRef = $taintedness;
}
/**
* @param TypedElementInterface $element
*/
protected static function clearRefData( TypedElementInterface $element ): void {
unset( $element->taintednessRef, $element->taintedMethodLinksRef );
}
/**
* Clears any previous error on the given element.
*
* @param TypedElementInterface $elem
*/
protected static function clearTaintError( TypedElementInterface $elem ): void {
unset( $elem->taintedOriginalError );
}
/**
* Get $func's taint, or null if not set. NOTE: This doesn't create a clone.
*
* @param FunctionInterface $func
* @return FunctionTaintedness|null
*/
protected static function getFuncTaint( FunctionInterface $func ): ?FunctionTaintedness {
return $func->funcTaint ?? null;
}
/**
* @param FunctionInterface $func
* @param FunctionTaintedness $funcTaint
*/
protected static function doSetFuncTaint( FunctionInterface $func, FunctionTaintedness $funcTaint ): void {
$func->funcTaint = $funcTaint;
}
/**
* @param FunctionInterface $func
* @return TypedElementInterface[]|null
*/
protected static function getRetObjs( FunctionInterface $func ): ?array {
$funcNode = $func->getNode();
if ( !$funcNode ) {
// If it has no node, it won't have any returned object, so don't return null, to avoid
// potential recursive analysis attempts.
return [];
}
return $funcNode->retObjs ?? null;
}
/**
* @note These are saved in the function node so that they can be shared by all implementations, without
* having to check the defining FQSEN of a method and canonicalize $func for lookup.
* @param FunctionInterface $func
* @param TypedElementInterface[] $retObjs
* @suppress PhanUnreferencedProtectedMethod Used in TaintednessVisitor
*/
protected static function addRetObjs( FunctionInterface $func, array $retObjs ): void {
$funcNode = $func->getNode();
if ( $funcNode ) {
$funcNode->retObjs = array_merge( $funcNode->retObjs ?? [], $retObjs );
}
}
/**
* @param FunctionInterface $func
*/
protected static function initRetObjs( FunctionInterface $func ): void {
$funcNode = $func->getNode();
if ( $funcNode ) {
$funcNode->retObjs ??= [];
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 17:32 (3 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
cb/e5/85465e2675321b03a0da97d066de
Default Alt Text
TaintednessAccessorsTrait.php (7 KB)

Event Timeline