Skip to content

Commit

Permalink
Update ReadMe and ChangeLog
Browse files Browse the repository at this point in the history
  • Loading branch information
Coding-Enthusiast committed Nov 13, 2024
1 parent 15c2291 commit 07f95de
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 19 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
### Next Release (future ideas)
[Commits after previous release](https://github.com/Coding-Enthusiast/FinderOuter/compare/v0.19.1.0...master)
[Commits after previous release](https://github.com/Coding-Enthusiast/FinderOuter/compare/v0.20.0.0...master)
[RoadMap](https://github.com/Coding-Enthusiast/FinderOuter/issues/47)

### Release 0.20.0 (2024-11-13)
[Full Changelog](https://github.com/Coding-Enthusiast/FinderOuter/compare/v0.19.1.0...v0.20.0.0)
* **New feature:** new copy and paste buttons for all search-spaces to be able to copy over lists
* **New feature:** recovering encryption password used for bitcoin core wallet.dat files
* Some bug fixes and code improvements

### Release 0.19.1 (2024-01-24)
[Full Changelog](https://github.com/Coding-Enthusiast/FinderOuter/compare/v0.19.0.0...v0.19.1.0)
* Fix a bug in VMs where FinderOuter crashed if user entered an invalid input
Expand Down
33 changes: 15 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ Contribution is always welcome. Please report any bugs you find or any improveme
![Preview](/Doc/Images/MainPreview.jpg)

## Available recovery options
#### 1. Message signature verification
User can enter a message signature here to verify it. In case there is a problem with the message (except being an
actually invalid signature), the code can search to find the common issues that some signing tools have and fix them.
#### 1. Missing Base-16 characters
This option is similar to previous feature but works for base-16 (hexadecimal) private keys. Since there is no checksum in this
encoding it requires an additional input to check each permutation against. It accepts any address type and public keys.
This option is slower in comparison because it uses ECC and that is not yet optimized.

#### 2. Missing Base-58 characters
This option can be used to recover any base-58 encoded string with a checksum that is missing some characters. For example
Expand All @@ -47,36 +48,32 @@ It works for (1) [WIFs](https://en.bitcoin.it/wiki/Wallet_import_format) (Base-5
(2) [Addresses](https://en.bitcoin.it/wiki/Address) (Base-58 encoded P2PKH or P2SH address)
(3) [BIP-38](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki) (Base-58 encoded encrypted private key).

There is also a "special case" for private keys missing 1, 2 or 3 characters at _unknown_ positions.

#### 3. Missing Base-16 characters
This option is similar to previous feature but works for base-16 (hexadecimal) private keys. Since there is no checksum in this
encoding it requires an additional input to check each permutation against. It accepts any address type and public keys.
This option is slower in comparison because it uses ECC and that is not yet optimized.

#### 4. Missing mini-privatekey characters
#### 3. Missing mini-privatekey characters
This option is similar to 2 and 3 but works for [mini-privatekeys](https://en.bitcoin.it/wiki/Mini_private_key_format)
(eg. SzavMBLoXU6kDrqtUVmffv). It requires the corresponding address or public key of the minikey to check
each possible key against, as a result it is also slower since it depends on ECC and has 2 additional hashes.

#### 5. Missing mnomonic (seed) words
#### 4. Missing BIP-38 password
This option can recover passwords used in encrypting bitcoin private keys using the
[BIP-38](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki) proposal. The available password recovery modes
are the same as mnemonic passphrase option.

#### 5. Missing bitcoin core wallet.dat password
This option can recover passwords used to encrypt the bitcoin core wallet files.

#### 6. Missing mnomonic (seed) words
This option works for both [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) and Electrum mnemonics
that have some missing words. It requires knowing one child (private/public) key or address created from that seed and the
exact derivation path of it.

#### 6. Missing mnemonic passphrase
#### 7. Missing mnemonic passphrase
This option is used to recover the extension words (aka passphrase) used in mnemonics. It works for both
[BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) and Electrum mnemonics algorithms. The available
passphrase recovery modes are:
a. Alphanumeric: This is when the passphrase consists of letter, numbers and symbols and is random. Example: `OT!pA?8i`
b. CustomChars: This mode allows user to define their own set of characters to be used in the passphrase.
c. _soon_

#### 7. Missing BIP-38 password
This option can recover passwords used in encrypting bitcoin private keys using the
[BIP-38](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki) proposal. The available password recovery modes
are the same as mnemonic passphrase option.

#### 8. Missing BIP-32 derivation path
This option could be used to find derivation path of a child key (private key, public key or the address) by having the mnemonic
or the extended master keys (xprv or xpub). It only checks a hard-coded list of popular derivation paths.
Expand Down

0 comments on commit 07f95de

Please sign in to comment.