1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-12-23 17:17:13 +00:00
tgbotapi/docs/dev.inmo.tgbotapi.utils.passport/index.html

183 lines
22 KiB
HTML
Raw Normal View History

<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 type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.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" async="async"></script> </head>
<body>
<div id="container">
<div id="leftColumn"><a href="../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.utils.passport////PointingToDeclaration//1103238440">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">docs</a>/<a href="index.html">dev.inmo.tgbotapi.utils.passport</a></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>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span><span>Package</span></span> <span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>tgbotapi.</span><wbr></wbr><span>utils.</span><wbr></wbr><span>passport</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"><a href="-a-e-s-decryptor/index.html"><span><span>AESDecryptor</span></span></a><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="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace">class <a href="-a-e-s-decryptor/index.html">AESDecryptor</a>(key: <span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span>, iv: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>) : <span data-unresolved-link="dev.inmo.tgbotapi.utils.passport/Decryptor///PointingToDeclaration/">Decryptor</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></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"><a href="-decryptor/index.html"><span><span>Decryptor</span></span></a><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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">interface <a href="-decryptor/index.html">Decryptor</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></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"><a href="create-decryptor.html"><span>create</span><wbr></wbr><span><span>Decryptor</span></span></a><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="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.types.passport.credentials/-end-data-credentials/index.html#642247514%2FExtensions%2F2063174889">EndDataCredentials</a>.<a href="create-decryptor.html">createDecryptor</a>(): <span data-unresolved-link="dev.inmo.tgbotapi.utils.passport/Decryptor///PointingToDeclaration/">Decryptor</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace">fun <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a>&lt;<span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span>, <span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span>&gt;.<a href="create-decryptor.html">createDecryptor</a>(): <span data-unresolved-link="dev.inmo.tgbotapi.utils.passport/Decryptor///PointingToDeclaration/">Decryptor</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></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"><a href="decrypt-data.html"><span>decrypt</span><wbr></wbr><span><span>Data</span></span></a><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="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.types.passport.credentials/-end-data-credentials/index.html#642247514%2FExtensions%2F2063174889">EndDataCredentials</a>.<a href="decrypt-data.html">decryptData</a>(bytes: <span data-unresolved-link="dev.inmo.tgbotapi.types.passport.credentials/EncryptedData///PointingToDeclaration/">EncryptedData</span>): <span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="463232018%2FFunctions%2F2063174889" anchor-label="decryptFile" id="463232018%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"><a href="decrypt-file.html"><span>decrypt</span><wbr></wbr><span><span>File</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="463232018%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="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.types.passport.credentials/-file-credentials/index.html#-341797263%2FExtensions%2F2063174889">FileCredentials</a>.<a href="decrypt-file.html">decryptFile</a>(fileBytes: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>): <span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace">suspend fun <a href="../dev.inmo.tgbotapi.types.passport.credentials/-file-credentials/index.html#-341797263%2FExtensions%2F2063174889">FileCredentials</a>.<a href="decrypt-file.html">decryptFile</a>(bot: <span data-unresolved-link="dev.inmo.tgbotapi.bot/TelegramBot///PointingToDeclaration/">TelegramBot</span>, passportFile: <span data-unresolved-link="dev.inmo.tgbotapi.types.passport.encrypted/PassportFile///PointingToDeclaration/">PassportFile</span>): <span data-unresolved-link="dev.inmo.micro_utils.crypto/SourceBytes///PointingToDeclaration/">SourceBytes</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></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"><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><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="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.types.passport.credentials/-encrypted-credentials/index.html#-481230215%2FExtensions%2F2063174889">EncryptedCredentials</a>.<a href="decrypt-with-p-k-c-s8-private-key.html">decryptWithPKCS8PrivateKey</a>(privateKey: <a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivateKey.html">PrivateKey</a>): <span data-unresolved-link="dev.inmo.tgbotapi.types.passport.credentials/DecryptedCredentials///PointingToDeclaration/">DecryptedCredentials</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace">fun <a href="../dev.inmo.tgbotapi.types.passport.credentials/-encrypted-credentials/index.html#-481230215%2FExtensions%2F2063174889">EncryptedCredentials</a>.<a href="decrypt-with-p-k-c-s8-private-key.html">decryptWithPKCS8PrivateKey</a>(key: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <span data-unresolved-link="dev.inmo.tgbotapi.types.passport.credentials/DecryptedCredentials///PointingToDeclaration/">DecryptedCredentials</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></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"><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><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="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/jvmMain" data-filterable-set=":docs:dokkaHtml/jvmMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/jvmMain"><div class="symbol monospace">inline fun &lt;<a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a>&gt; <a href="../dev.inmo.tgbotapi.types.passport/-passport-data/index.html#1290807463%2FExtensions%2F2063174889">PassportData</a>.<a href="do-in-decryption-context-with-p-k-c-s8-key.html">doInDecryptionContextWithPKCS8Key</a>(pkcs8Key: <a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivateKey.html">PrivateKey</a>, expectedNonce: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, crossinline block: <span data-unresolved-link="dev.inmo.tgbotapi.types.passport.decrypted/SecureData///PointingToDeclaration/">SecureData</span>.() -&gt; <a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a>): <a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace">inline fun &lt;<a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a>&gt; <a href="../dev.inmo.tgbotapi.types.passport/-passport-data/index.html#1290807463%2FExtensions%2F2063174889">PassportData</a>.<a href="do-in-decryption-context-with-p-k-c-s8-key.html">doInDecryptionContextWithPKCS8Key</a>(pkcs8Key: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, expectedNonce: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, crossinline block: <span data-unresolved-link="dev.inmo.tgbotapi.types.passport.decrypted/SecureData///PointingToDeclaration/">SecureData</span>.() -&gt; <a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a>): <a href="do-in-decryption-context-with-p-k-c-s8-key.html">T</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>