Dash RPCs - Add details to the keepass RPC

This commit is contained in:
thephez 2017-12-06 12:31:36 -05:00
parent b3fc565eba
commit 6fd6f8b8ab
4 changed files with 105 additions and 12 deletions

View file

@ -274,7 +274,7 @@ default.
* [ImportPubKey][rpc importpubkey]: {{summary_importPubKey}} * [ImportPubKey][rpc importpubkey]: {{summary_importPubKey}}
* [ImportWallet][rpc importwallet]: {{summary_importWallet}} * [ImportWallet][rpc importwallet]: {{summary_importWallet}}
* [InstantSendToAddress][rpc instantsendtoaddress]: {{summary_instantSendToAddress}} * [InstantSendToAddress][rpc instantsendtoaddress]: {{summary_instantSendToAddress}}
* [Keepass][rpc keepass]: {{summary_keepass}} {{DARKCOIN_NEW0_11_0}} * [KeePass][rpc keepass]: {{summary_keepass}} {{DARKCOIN_NEW0_11_0}}
* [KeyPoolRefill][rpc keypoolrefill]: {{summary_keyPoolRefill}} * [KeyPoolRefill][rpc keypoolrefill]: {{summary_keyPoolRefill}}
* [ListAccounts][rpc listaccounts]: {{summary_listAccounts}} {{DEPRECATED}} * [ListAccounts][rpc listaccounts]: {{summary_listAccounts}} {{DEPRECATED}}
* [ListAddressGroupings][rpc listaddressgroupings]: {{summary_listAddressGroupings}} * [ListAddressGroupings][rpc listaddressgroupings]: {{summary_listAddressGroupings}}

View file

@ -4,30 +4,124 @@ http://opensource.org/licenses/MIT.
{% endcomment %} {% endcomment %}
{% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/keepass.md" %} {% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/keepass.md" %}
##### Keepass ##### KeePass
{% include helpers/subhead-links.md %} {% include helpers/subhead-links.md %}
{% assign summary_keepass="" %} {% assign summary_keepass="provides commands for configuring and managing KeePass authentication" %}
<!-- __ -->
{% autocrossref %} {% autocrossref %}
The `keepass` RPC {{summary_keepass}} The `keepass` RPC {{summary_keepass}}
*Parameter #1---PARAMETER DESCRIPTION* *Parameter #1---Command mode*
*Result---RESULT DESCRIPTION* {% itemplate ntpd1 %}
- n: "`mode`"
t: "string"
p: "Required (exactly 1)"
d: "The command mode to use:<br>`genkey`,<br>`init`,<br>`setpassphrase`"
{% enditemplate %}
*Command Options*
Mode | Description
--- | --- | --- |
`genkey` | Generates a base64 encoded 256 bit AES key that can be used for the communication with KeePassHttp. This is only necessary for manual configuration.
`init` | Sets up the association between Dash Core and KeePass by generating an AES key and sending an association message to KeePassHttp. This will trigger KeePass to ask for an Id for the association. Returns the association and the base64 encoded string for the AES key.
`setpassphrase` | Updates the passphrase in KeePassHttp to a new value. This should match the passphrase you intend to use for the wallet. Please note that the standard RPC commands walletpassphrasechange and the wallet encryption from the QT GUI already send the updates to KeePassHttp, so this is only necessary for manual manipulation of the password.
**Command Mode - `genkey`**
*Result---the new key*
{% itemplate ntpd1 %}
- n: "Result"
t: "string (base64)"
p: "Required (exactly 1)"
d: "The new key"
{% enditemplate %}
*Example from Dash Core 0.12.2* *Example from Dash Core 0.12.2*
Manually generate a key
{% highlight bash %} {% highlight bash %}
dash-cli -testnet keepass dash-cli -testnet keepass genkey
{% endhighlight %} {% endhighlight %}
Result: Result:
{% highlight json %} {% highlight bash %}
*INSERT RESULTS HERE* Generated Key: dNjo+J8Jb30txbJiKq4s9H6vEgWq/whb1w9bb2cTOFo=
{% endhighlight %}
**Command Mode - `init`**
*Result---initialization response*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required (exactly 1)"
d: "The success/error status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
Automatically initialize
{% highlight bash %}
dash-cli -testnet keepass init
{% endhighlight %} {% endhighlight %}
*See also:* Result (wrapped):
{% highlight bash %}
Association successful. Id: testwalletassociation - \
Key: MSb+JLygqz7ZH40SyJ1QR62i00IXoa3tmT85MGGI2K0=
{% endhighlight %}
**Command Mode - `setpassphrase`**
*Parameter #2---Passphrase*
{% itemplate ntpd1 %}
- n: "Passphrase"
t: "string"
p: "Required (exactly 1)"
d: "The passphrase to set"
{% enditemplate %}
*Result---status*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required (exactly 1)"
d: "The success/error status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
Set KeePass passphrase
{% highlight bash %}
dash-cli -testnet keepass setpassphrase 1BWi20Xyk76uWumxJQy4
{% endhighlight %}
Result:
{% highlight bash %}
setlogin: Updated credentials.
{% endhighlight %}
*See also: none*
{% endautocrossref %} {% endautocrossref %}

View file

@ -23,7 +23,6 @@ This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_estimateSmartPriority="estimates the priority that a transaction needs in order to be included within a certain number of blocks as a free high-priority transaction and returns the number of blocks for which the estimate is valid." %} {% assign summary_estimateSmartPriority="estimates the priority that a transaction needs in order to be included within a certain number of blocks as a free high-priority transaction and returns the number of blocks for which the estimate is valid." %}
{% assign summary_fundRawTransaction="adds inputs to a transaction until it has enough in value to meet its out value." %} {% assign summary_fundRawTransaction="adds inputs to a transaction until it has enough in value to meet its out value." %}
{% assign summary_gObject="provides a set of commands for managing governance objects and displaying information about them." %} {% assign summary_gObject="provides a set of commands for managing governance objects and displaying information about them." %}
{% assign summary_gObjectCheck="." %}
{% assign summary_generate="mines blocks immediately (before the RPC call returns)." %} {% assign summary_generate="mines blocks immediately (before the RPC call returns)." %}
{% assign summary_generateToAddress="mines blocks immediately to a specified address." %} {% assign summary_generateToAddress="mines blocks immediately to a specified address." %}
{% assign summary_getAccount="returns the name of the account associated with the given address." %} {% assign summary_getAccount="returns the name of the account associated with the given address." %}
@ -87,7 +86,7 @@ This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_importPubKey="imports a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend" %} {% assign summary_importPubKey="imports a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend" %}
{% assign summary_importWallet="imports private keys from a file in wallet dump file format (see the `dumpwallet` RPC). These keys will be added to the keys currently in the wallet. This call may need to rescan all or parts of the block chain for transactions affecting the newly-added keys, which may take several minutes." %} {% assign summary_importWallet="imports private keys from a file in wallet dump file format (see the `dumpwallet` RPC). These keys will be added to the keys currently in the wallet. This call may need to rescan all or parts of the block chain for transactions affecting the newly-added keys, which may take several minutes." %}
{% assign summary_instantSendToAddress="InstantSend an amount to a given address." %} {% assign summary_instantSendToAddress="InstantSend an amount to a given address." %}
{% assign summary_keepass="" %} {% assign summary_keepass="provides commands for configuring and managing KeePass authentication" %}
{% assign summary_keyPoolRefill="fills the cache of unused pre-generated keys (the keypool)." %} {% assign summary_keyPoolRefill="fills the cache of unused pre-generated keys (the keypool)." %}
{% assign summary_listAccounts="lists accounts and their balances." %} {% assign summary_listAccounts="lists accounts and their balances." %}
{% assign summary_listAddressGroupings="lists groups of addresses that may have had their common ownership made public by common use as inputs in the same transaction or from being used as change from a previous transaction." %} {% assign summary_listAddressGroupings="lists groups of addresses that may have had their common ownership made public by common use as inputs in the same transaction or from being used as change from a previous transaction." %}

View file

@ -694,7 +694,7 @@ th.tg-sort-header::-moz-selection { background:transparent; }th.tg-sort-header::
</tr> </tr>
<tr> <tr>
<td class="tg-b7b8">Wallet</td> <td class="tg-b7b8">Wallet</td>
<td class="tg-b7b8">Keepass</td> <td class="tg-b7b8">KeePass</td>
<td class="tg-dzk6">Y</td> <td class="tg-dzk6">Y</td>
<td class="tg-dzk6"></td> <td class="tg-dzk6"></td>
</tr> </tr>