1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-30 05:58:43 +00:00
tgbotapi/docs/dev.inmo.tgbotapi.utils.passport/index.html

199 lines
24 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dev.inmo.tgbotapi.utils.passport</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../";</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../index.html">
<span>docs</span>
</a>
</div>
<div>
4.2.1 </div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":docs:dokkaHtml/commonMain">common</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":docs:dokkaHtml/jvmMain">jvm</button>
</div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.utils.passport////PointingToDeclaration//1103238440">
<div class="breadcrumbs"><a href="../../index.html">docs</a><span class="delimiter">/</span><span class="current">dev.inmo.tgbotapi.utils.passport</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="-881615926%2FClasslikes%2F2063174889" anchor-label="AESDecryptor" id="-881615926%2FClasslikes%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-a-e-s-decryptor/index.html"><span><span>AESDecryptor</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-881615926%2FClasslikes%2F2063174889"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain" data-active="" data-toggle=":docs:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-a-e-s-decryptor/index.html">AESDecryptor</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span><span class="token punctuation">, </span></span><span class="parameter ">iv<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span> : <span data-unresolved-link="dev.inmo.tgbotapi.utils.passport/Decryptor///PointingToDeclaration/">Decryptor</span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="-1036886105%2FClasslikes%2F-1982836883" anchor-label="Decryptor" id="-1036886105%2FClasslikes%2F-1982836883" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-decryptor/index.html"><span><span>Decryptor</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1036886105%2FClasslikes%2F-1982836883"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-decryptor/index.html">Decryptor</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-925262677%2FFunctions%2F2063174889" anchor-label="createDecryptor" id="-925262677%2FFunctions%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="create-decryptor.html"><span>create</span><wbr></wbr><span><span>Decryptor</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-925262677%2FFunctions%2F2063174889"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain" data-active="" data-toggle=":docs:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../dev.inmo.tgbotapi.types.passport.credentials/-end-data-credentials/index.html#642247514%2FExtensions%2F2063174889">EndDataCredentials</a><span class="token punctuation">.</span><a href="create-decryptor.html"><span class="token function">createDecryptor</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.utils.passport/Decryptor///PointingToDeclaration/">Decryptor</span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span><span class="token punctuation">, </span><span class="token keyword"></span><span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="create-decryptor.html"><span class="token function">createDecryptor</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.utils.passport/Decryptor///PointingToDeclaration/">Decryptor</span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="-1004202529%2FFunctions%2F2063174889" anchor-label="decryptData" id="-1004202529%2FFunctions%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="decrypt-data.html"><span>decrypt</span><wbr></wbr><span><span>Data</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1004202529%2FFunctions%2F2063174889"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain" data-active="" data-toggle=":docs:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../dev.inmo.tgbotapi.types.passport.credentials/-end-data-credentials/index.html#642247514%2FExtensions%2F2063174889">EndDataCredentials</a><span class="token punctuation">.</span><a href="decrypt-data.html"><span class="token function">decryptData</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">bytes<span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.types.passport.credentials/EncryptedData///PointingToDeclaration/">EncryptedData</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="1657898035%2FFunctions%2F2063174889" anchor-label="decryptFile" id="1657898035%2FFunctions%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="decrypt-file.html"><span>decrypt</span><wbr></wbr><span><span>File</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1657898035%2FFunctions%2F2063174889"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain" data-active="" data-toggle=":docs:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../dev.inmo.tgbotapi.types.passport.credentials/-file-credentials/index.html#-341797263%2FExtensions%2F2063174889">FileCredentials</a><span class="token punctuation">.</span><a href="decrypt-file.html"><span class="token function">decryptFile</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">fileBytes<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../dev.inmo.tgbotapi.types.passport.credentials/-file-credentials/index.html#-341797263%2FExtensions%2F2063174889">FileCredentials</a><span class="token punctuation">.</span><a href="decrypt-file.html"><span class="token function">decryptFile</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">bot<span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.bot/TelegramBot///PointingToDeclaration/">TelegramBot</span><span class="token punctuation">, </span></span><span class="parameter ">passportFile<span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.types.files/PassportFile///PointingToDeclaration/">PassportFile</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="937869188%2FFunctions%2F2063174889" anchor-label="decryptWithPKCS8PrivateKey" id="937869188%2FFunctions%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="decrypt-with-p-k-c-s8-private-key.html"><span>decrypt</span><wbr></wbr><span>With</span><wbr></wbr><span>PKCS8Private</span><wbr></wbr><span><span>Key</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="937869188%2FFunctions%2F2063174889"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain" data-active="" data-toggle=":docs:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../dev.inmo.tgbotapi.types.passport.credentials/-encrypted-credentials/index.html#-481230215%2FExtensions%2F2063174889">EncryptedCredentials</a><span class="token punctuation">.</span><a href="decrypt-with-p-k-c-s8-private-key.html"><span class="token function">decryptWithPKCS8PrivateKey</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">privateKey<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivateKey.html">PrivateKey</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.types.passport.credentials/DecryptedCredentials///PointingToDeclaration/">DecryptedCredentials</span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../dev.inmo.tgbotapi.types.passport.credentials/-encrypted-credentials/index.html#-481230215%2FExtensions%2F2063174889">EncryptedCredentials</a><span class="token punctuation">.</span><a href="decrypt-with-p-k-c-s8-private-key.html"><span class="token function">decryptWithPKCS8PrivateKey</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.types.passport.credentials/DecryptedCredentials///PointingToDeclaration/">DecryptedCredentials</span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="153319104%2FFunctions%2F2063174889" anchor-label="doInDecryptionContextWithPKCS8Key" id="153319104%2FFunctions%2F2063174889" data-filterable-set=":docs:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="do-in-decryption-context-with-p-k-c-s8-key.html"><span>do</span><wbr></wbr><span>In</span><wbr></wbr><span>Decryption</span><wbr></wbr><span>Context</span><wbr></wbr><span>With</span><wbr></wbr><span><span>PKCS8Key</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="153319104%2FFunctions%2F2063174889"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain" data-active="" data-toggle=":docs:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a><span class="token operator">&gt; </span><a href="../dev.inmo.tgbotapi.types.passport/-passport-data/index.html#1290807463%2FExtensions%2F2063174889">PassportData</a><span class="token punctuation">.</span><a href="do-in-decryption-context-with-p-k-c-s8-key.html"><span class="token function">doInDecryptionContextWithPKCS8Key</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">pkcs8Key<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivateKey.html">PrivateKey</a><span class="token punctuation">, </span></span><span class="parameter ">expectedNonce<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">crossinline </span>block<span class="token operator">: </span><span class="token keyword"></span><span data-unresolved-link="dev.inmo.tgbotapi.types.passport.decrypted/SecureData///PointingToDeclaration/">SecureData</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a><span class="token operator">&gt; </span><a href="../dev.inmo.tgbotapi.types.passport/-passport-data/index.html#1290807463%2FExtensions%2F2063174889">PassportData</a><span class="token punctuation">.</span><a href="do-in-decryption-context-with-p-k-c-s8-key.html"><span class="token function">doInDecryptionContextWithPKCS8Key</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">pkcs8Key<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">expectedNonce<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">crossinline </span>block<span class="token operator">: </span><span class="token keyword"></span><span data-unresolved-link="dev.inmo.tgbotapi.types.passport.decrypted/SecureData///PointingToDeclaration/">SecureData</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a></div></div> </div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</body>
</html>