mainwp.dev/source-code/child/classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html
2025-03-17 19:02:54 -04:00

2214 lines
120 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>MainWP Child Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">MainWP Child Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/mainwp.html" class="">MainWP</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/mainwp-child.html" class="">Child</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/paragonie.html" class="">ParagonIE</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/paragonie-constanttime.html" class="">ConstantTime</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/phpseclib3.html" class="">phpseclib3</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/phpseclib3-common.html" class="">Common</a>
</li>
<li>
<a href="namespaces/phpseclib3-crypt.html" class="">Crypt</a>
</li>
<li>
<a href="namespaces/phpseclib3-exception.html" class="">Exception</a>
</li>
<li>
<a href="namespaces/phpseclib3-file.html" class="">File</a>
</li>
<li>
<a href="namespaces/phpseclib3-math.html" class="">Math</a>
</li>
<li>
<a href="namespaces/phpseclib3-net.html" class="">Net</a>
</li>
<li>
<a href="namespaces/phpseclib3-system.html" class="">System</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/MainWP.html" class="">MainWP</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/MainWP-Child.html" class="">Child</a>
</li>
<li>
<a href="packages/MainWP-ChildCreditsPlugin.html" class="">ChildCreditsPlugin</a>
</li>
<li>
<a href="packages/MainWP-Dashboard.html" class="">Dashboard</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/MainWPChild.html" class="">MainWPChild</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/ParagonIE.html" class="">ParagonIE</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/ParagonIE-ConstantTime.html" class="">ConstantTime</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -reports">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3.html">phpseclib3</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3-crypt.html">Crypt</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3-crypt-rsa.html">RSA</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3-crypt-rsa-formats.html">Formats</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3-crypt-rsa-formats-keys.html">Keys</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
PSS
<span class="phpdocumentor-element__extends">
extends <a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html"><abbr title="\phpseclib3\Crypt\Common\Formats\Keys\PKCS8">PKCS8</abbr></a>
</span>
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP.html">MainWP</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP-Child.html">Child</a></li>
</ul>
</div>
</h2>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>Abstract</span><span>Yes</span></div>
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.37" class="phpdocumentor-element-found-in__source" data-line="37" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">PKCS#8 Formatted RSA-PSS Key Handler</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Jim Wigginton <a href="mailto:terrafrost@php.net">terrafrost@php.net</a></p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-constants">
Constants
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_ANY">MODE_ANY</a>
<span>
&nbsp;= 0 </span>
</dt>
<dd>Auto-detect the format</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_DER">MODE_DER</a>
<span>
&nbsp;= 2 </span>
</dt>
<dd>Require raw DER&#039;s be supplied</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_PEM">MODE_PEM</a>
<span>
&nbsp;= 1 </span>
</dt>
<dd>Require base64-encoded PEM&#039;s be supplied</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#constant_OID_NAME">OID_NAME</a>
<span>
&nbsp;= &#039;id-RSASSA-PSS&#039; </span>
</dt>
<dd>OID Name</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#constant_OID_VALUE">OID_VALUE</a>
<span>
&nbsp;= &#039;1.2.840.113549.1.1.10&#039; </span>
</dt>
<dd>OID Value</dd>
</dl>
<h4 id="toc-properties">
Properties
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#property_childOIDsLoaded">$childOIDsLoaded</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Child OIDs loaded</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#property_format">$format</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Is the key a base-64 encoded PEM, DER or should it be auto-detected?</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultEncryptionAlgorithm">$defaultEncryptionAlgorithm</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Default encryption algorithm</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultEncryptionScheme">$defaultEncryptionScheme</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Default encryption scheme</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultIterationCount">$defaultIterationCount</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Default Iteration Count</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultPRF">$defaultPRF</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Default PRF</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#property_oidsLoaded">$oidsLoaded</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>OIDs loaded</dd>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_extractEncryptionAlgorithm">extractEncryptionAlgorithm()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Returns the encryption parameters used by the key</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_load">load()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Break a public or private key down into its constituent components</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requireAny">requireAny()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Accept any format and auto detect the format</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requireDER">requireDER()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Require raw DER&#039;s be supplied</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requirePEM">requirePEM()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Require base64-encoded PEM&#039;s be supplied</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePrivateKey">savePrivateKey()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Convert a private key to the appropriate format.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePSSParams">savePSSParams()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Encodes PSS parameters</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePublicKey">savePublicKey()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Convert a public key to the appropriate format</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setEncryptionAlgorithm">setEncryptionAlgorithm()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets the default encryption algorithm</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setEncryptionScheme">setEncryptionScheme()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets the default encryption algorithm for PBES2</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setIterationCount">setIterationCount()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets the iteration count</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setPRF">setPRF()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets the PRF for PBES2</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_wrapPrivateKey">wrapPrivateKey()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Wrap a private key appropriately</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_wrapPublicKey">wrapPublicKey()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Wrap a public key appropriately</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1EncryptionObject">getPBES1EncryptionObject()</a>
<span>
&nbsp;: <a href="classes/phpseclib3-Crypt-Common-SymmetricKey.html"><abbr title="\phpseclib3\Crypt\Common\SymmetricKey">SymmetricKey</abbr></a> </span>
</dt>
<dd>Returns a SymmetricKey object based on a PBES1 $algo</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1Hash">getPBES1Hash()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns a hash based on a PBES1 $algo</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1KDF">getPBES1KDF()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns a KDF baesd on a PBES1 $algo</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES2EncryptionObject">getPBES2EncryptionObject()</a>
<span>
&nbsp;: <abbr title="\phpseclib3\Crypt\Common\Formats\Keys\SymmetricKey">SymmetricKey</abbr> </span>
</dt>
<dd>Returns a SymmetricKey object baesd on a PBES2 $algo</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a class="" href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_initialize_static_variables">initialize_static_variables()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Initialize static variables</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a class="" href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_preParse">preParse()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Perform some preliminary parsing of the key</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_MODE_ANY">
MODE_ANY
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_ANY" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php">PKCS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.26" class="phpdocumentor-element-found-in__source" data-line="26" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Auto-detect the format</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">MODE_ANY</span>
= <span class="phpdocumentor-signature__default-value">0</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_MODE_DER">
MODE_DER
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_DER" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php">PKCS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.34" class="phpdocumentor-element-found-in__source" data-line="34" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Require raw DER&#039;s be supplied</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">MODE_DER</span>
= <span class="phpdocumentor-signature__default-value">2</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_MODE_PEM">
MODE_PEM
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_PEM" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php">PKCS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.30" class="phpdocumentor-element-found-in__source" data-line="30" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Require base64-encoded PEM&#039;s be supplied</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">MODE_PEM</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_OID_NAME">
OID_NAME
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#constant_OID_NAME" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.44" class="phpdocumentor-element-found-in__source" data-line="44" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">OID Name</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">OID_NAME</span>
= <span class="phpdocumentor-signature__default-value">&#039;id-RSASSA-PSS&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_OID_VALUE">
OID_VALUE
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#constant_OID_VALUE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.51" class="phpdocumentor-element-found-in__source" data-line="51" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">OID Value</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">OID_VALUE</span>
= <span class="phpdocumentor-signature__default-value">&#039;1.2.840.113549.1.1.10&#039;</span>
</code>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
-static "
>
<h4 class="phpdocumentor-element__name" id="property_childOIDsLoaded">
$childOIDsLoaded
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#property_childOIDsLoaded" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.65" class="phpdocumentor-element-found-in__source" data-line="65" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Child OIDs loaded</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$childOIDsLoaded</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
-static "
>
<h4 class="phpdocumentor-element__name" id="property_format">
$format
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#property_format" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php">PKCS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.42" class="phpdocumentor-element-found-in__source" data-line="42" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Is the key a base-64 encoded PEM, DER or should it be auto-detected?</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$format</span>
= <span class="phpdocumentor-signature__default-value">self::MODE_ANY</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_defaultEncryptionAlgorithm">
$defaultEncryptionAlgorithm
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultEncryptionAlgorithm" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.52" class="phpdocumentor-element-found-in__source" data-line="52" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Default encryption algorithm</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$defaultEncryptionAlgorithm</span>
= <span class="phpdocumentor-signature__default-value">&#039;id-PBES2&#039;</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_defaultEncryptionScheme">
$defaultEncryptionScheme
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultEncryptionScheme" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.61" class="phpdocumentor-element-found-in__source" data-line="61" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Default encryption scheme</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$defaultEncryptionScheme</span>
= <span class="phpdocumentor-signature__default-value">&#039;aes128-CBC-PAD&#039;</span></code>
<section class="phpdocumentor-description"><p>Only used when defaultEncryptionAlgorithm is id-PBES2</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_defaultIterationCount">
$defaultIterationCount
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultIterationCount" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">77</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.77" class="phpdocumentor-element-found-in__source" data-line="77" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Default Iteration Count</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$defaultIterationCount</span>
= <span class="phpdocumentor-signature__default-value">2048</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_defaultPRF">
$defaultPRF
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultPRF" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.70" class="phpdocumentor-element-found-in__source" data-line="70" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Default PRF</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$defaultPRF</span>
= <span class="phpdocumentor-signature__default-value">&#039;id-hmacWithSHA256&#039;</span></code>
<section class="phpdocumentor-description"><p>Only used when defaultEncryptionAlgorithm is id-PBES2</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_oidsLoaded">
$oidsLoaded
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#property_oidsLoaded" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.58" class="phpdocumentor-element-found-in__source" data-line="58" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">OIDs loaded</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$oidsLoaded</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_extractEncryptionAlgorithm">
extractEncryptionAlgorithm()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_extractEncryptionAlgorithm" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">692</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.692" class="phpdocumentor-element-found-in__source" data-line="692" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Returns the encryption parameters used by the key</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">extractEncryptionAlgorithm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_load">
load()
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_load" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">98</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.98" class="phpdocumentor-element-found-in__source" data-line="98" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Break a public or private key down into its constituent components</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">load</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$password</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>optional</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_requireAny">
requireAny()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requireAny" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php">PKCS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.68" class="phpdocumentor-element-found-in__source" data-line="68" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Accept any format and auto detect the format</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">requireAny</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>This is the default setting</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_requireDER">
requireDER()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requireDER" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php">PKCS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.57" class="phpdocumentor-element-found-in__source" data-line="57" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Require raw DER&#039;s be supplied</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">requireDER</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_requirePEM">
requirePEM()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requirePEM" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php">PKCS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.48" class="phpdocumentor-element-found-in__source" data-line="48" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Require base64-encoded PEM&#039;s be supplied</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">requirePEM</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_savePrivateKey">
savePrivateKey()
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePrivateKey" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">167</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.167" class="phpdocumentor-element-found-in__source" data-line="167" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Convert a private key to the appropriate format.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">savePrivateKey</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$n</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$e</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$d</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$primes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$exponents</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$coefficients</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$n</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$e</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$d</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$primes</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$exponents</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$coefficients</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$password</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>optional</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>optional</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_savePSSParams">
savePSSParams()
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePSSParams" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">201</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.201" class="phpdocumentor-element-found-in__source" data-line="201" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Encodes PSS parameters</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">savePSSParams</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_savePublicKey">
savePublicKey()
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePublicKey" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">185</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.185" class="phpdocumentor-element-found-in__source" data-line="185" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Convert a public key to the appropriate format</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">savePublicKey</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$n</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$e</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$n</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$e</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Math-BigInteger.html"><abbr title="\phpseclib3\Math\BigInteger">BigInteger</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>optional</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_setEncryptionAlgorithm">
setEncryptionAlgorithm()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setEncryptionAlgorithm" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.91" class="phpdocumentor-element-found-in__source" data-line="91" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Sets the default encryption algorithm</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setEncryptionAlgorithm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$algo</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_setEncryptionScheme">
setEncryptionScheme()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setEncryptionScheme" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">101</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.101" class="phpdocumentor-element-found-in__source" data-line="101" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Sets the default encryption algorithm for PBES2</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setEncryptionScheme</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$algo</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_setIterationCount">
setIterationCount()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setIterationCount" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.111" class="phpdocumentor-element-found-in__source" data-line="111" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Sets the iteration count</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setIterationCount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$count</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$count</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_setPRF">
setPRF()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setPRF" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">121</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.121" class="phpdocumentor-element-found-in__source" data-line="121" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Sets the PRF for PBES2</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setPRF</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$algo</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-protected
-static "
>
<h4 class="phpdocumentor-element__name" id="method_wrapPrivateKey">
wrapPrivateKey()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_wrapPrivateKey" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">528</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.528" class="phpdocumentor-element-found-in__source" data-line="528" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Wrap a private key appropriately</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">wrapPrivateKey</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attr</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$oid</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$publicKey</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$attr</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$password</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$oid</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>optional</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$publicKey</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>optional</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>optional</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
-static "
>
<h4 class="phpdocumentor-element__name" id="method_wrapPublicKey">
wrapPublicKey()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_wrapPublicKey" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">637</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.637" class="phpdocumentor-element-found-in__source" data-line="637" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Wrap a public key appropriately</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">wrapPublicKey</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$oid</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$oid</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getPBES1EncryptionObject">
getPBES1EncryptionObject()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1EncryptionObject" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">132</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Returns a SymmetricKey object based on a PBES1 $algo</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getPBES1EncryptionObject</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/phpseclib3-Crypt-Common-SymmetricKey.html"><abbr title="\phpseclib3\Crypt\Common\SymmetricKey">SymmetricKey</abbr></a></span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$algo</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/phpseclib3-Crypt-Common-SymmetricKey.html"><abbr title="\phpseclib3\Crypt\Common\SymmetricKey">SymmetricKey</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getPBES1Hash">
getPBES1Hash()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1Hash" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.182" class="phpdocumentor-element-found-in__source" data-line="182" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Returns a hash based on a PBES1 $algo</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getPBES1Hash</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$algo</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getPBES1KDF">
getPBES1KDF()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1KDF" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.197" class="phpdocumentor-element-found-in__source" data-line="197" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Returns a KDF baesd on a PBES1 $algo</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getPBES1KDF</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$algo</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getPBES2EncryptionObject">
getPBES2EncryptionObject()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES2EncryptionObject" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">218</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.218" class="phpdocumentor-element-found-in__source" data-line="218" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Returns a SymmetricKey object baesd on a PBES2 $algo</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getPBES2EncryptionObject</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\phpseclib3\Crypt\Common\Formats\Keys\SymmetricKey">SymmetricKey</abbr></span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$algo</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\phpseclib3\Crypt\Common\Formats\Keys\SymmetricKey">SymmetricKey</abbr></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_initialize_static_variables">
initialize_static_variables()
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_initialize_static_variables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-rsa-formats-keys-pss.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php">PSS.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.70" class="phpdocumentor-element-found-in__source" data-line="70" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Initialize static variables</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">initialize_static_variables</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_preParse">
preParse()
<a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_preParse" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-crypt-common-formats-keys-pkcs8.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php">PKCS8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">665</span>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#source-view.665" class="phpdocumentor-element-found-in__source" data-line="665" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/Common/Formats/Keys/PKCS8.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Perform some preliminary parsing of the key</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">preParse</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__reference-operator">&amp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Crypt/RSA/Formats/Keys/PSS.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#toc-constants">Constants</a></li>
<li><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#toc-properties">Properties</a></li>
<li><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Constants</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_ANY">MODE_ANY</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_DER">MODE_DER</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#constant_MODE_PEM">MODE_PEM</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#constant_OID_NAME">OID_NAME</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#constant_OID_VALUE">OID_VALUE</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#property_childOIDsLoaded">$childOIDsLoaded</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#property_format">$format</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultEncryptionAlgorithm">$defaultEncryptionAlgorithm</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultEncryptionScheme">$defaultEncryptionScheme</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultIterationCount">$defaultIterationCount</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#property_defaultPRF">$defaultPRF</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#property_oidsLoaded">$oidsLoaded</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_extractEncryptionAlgorithm">extractEncryptionAlgorithm()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_load">load()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requireAny">requireAny()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requireDER">requireDER()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS.html#method_requirePEM">requirePEM()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePrivateKey">savePrivateKey()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePSSParams">savePSSParams()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_savePublicKey">savePublicKey()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setEncryptionAlgorithm">setEncryptionAlgorithm()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setEncryptionScheme">setEncryptionScheme()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setIterationCount">setIterationCount()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_setPRF">setPRF()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_wrapPrivateKey">wrapPrivateKey()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_wrapPublicKey">wrapPublicKey()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1EncryptionObject">getPBES1EncryptionObject()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1Hash">getPBES1Hash()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES1KDF">getPBES1KDF()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_getPBES2EncryptionObject">getPBES2EncryptionObject()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#method_initialize_static_variables">initialize_static_variables()</a></li>
<li class=""><a href="classes/phpseclib3-Crypt-Common-Formats-Keys-PKCS8.html#method_preParse">preParse()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/phpseclib3-Crypt-RSA-Formats-Keys-PSS.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>