Bitmessage Wiki - User contributions [en]

Public key to bitmessage address

2022-08-04T10:49:05Z

AyrA: Add key format details and hint about API binary data

This page briefly describes, how to generate a Bitmessage Address from a public key.
The variable after each step in the list is used to refer to the step later.
Numbers used below are encoded as [[Protocol specification#Variable length integer|var_int]]

A <code>+</code> in this documentation means concatenation.

# Create two key pairs using secp256k1, one for encryption and one for signing (privEnc, pubEnc, privSign, pubSign)
# Merge keys together using <code>pubSign + pubEnc</code>. Be sure to use the uncompressed keys (65 bytes per key, serialized X9.62 format). (A)
# <code>SHA512(A)</code>. (B)
# <code>RIPEMD160(B)</code>. (C)
# Repeat step 1-4 until you have a result that starts with at least one zero. More zeros are permitted and cause a shorter address hash later. (D)
# Remove all zeros at the beginning of D. (E)
# <code>Address Version + Stream number + E</code>. (F)
# <code>SHA512(SHA512(F))</code>. Keep the first four bytes. (G)
# <code>F + G</code>. (H)
# <code>Base58_encode(H)</code>. (I)
# <code>"BM-" + I</code>. (J)

J is your full address. You want to store this together with privSign and privEnc somewhere.
Note: The secp256k1 public keys don't need to be stored because they can be recreated again later from the private keys.

== Deterministic address ==

Deterministic addresses are created by using the first 32 bytes of <code>SHA512(passphrase + var_int)</code> as private key instead of randomly generating one.
The var_int for the signing key starts at 0, and for the encryption key at 1.
On every failed attempt to create an address, increment both integers by two and repeat the attempt. This means the integer for the signing key is always even,
and the one for the encryption key always odd and one bigger than the signing key.

== Address validation ==

Remove the "BM-" at the beginning and Base58 decode the rest.
Remove the last 4 bytes from the decoded data. Calculate SHA512 of the remaining address bytes and check if the first 4 bytes of the hash match the trimmed off 4 bytes.

Optional additional test: The address should start with two var_int values.
Currently, only stream 1 is supported, and the address version should be 2-4.

== Remarks ==

Bitmessage's base58 encoding uses the following sequence (the same as Bitcoin's): "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz".
Many existing libraries for base58 do not use this ordering.

The BM- formatted address is never transmitted over the network. It's used to find the correct public key and decrypt it.

As you may have noticed, the address version and stream number are not part of the keys, this means it's technically possible to move an address between streams and versions, although the Base58 encoding makes the address look completely different each time.

The PyBitmessage client doesn't states how the passphrase is converted into bytes.
This means using "äöü" as a passphrase will deliver different results across different operating systems because of how strings in python are handled internally.
The API should not have this problem because the string is given using base64 encoding, which preserves the original binary data.

The entire hashing and leading zero restrictions only apply to the public signing key, not the encryption key.

Public key to bitmessage address

2022-08-04T02:11:07Z

AyrA: /* Deterministic address */

This page briefly describes, how to generate a Bitmessage Address from a public key.
The variable after each step in the list is used to refer to the step later.
Numbers used below are encoded as [[Protocol specification#Variable length integer|var_int]]

A <code>+</code> in this documentation means concatenation.

# Create two key pairs using secp256k1, one for encryption and one for signing (privEnc, pubEnc, privSign, pubSign)
# Merge keys together using <code>pubSign + pubEnc</code>. Be sure to use the uncompressed keys (64 bytes per key, X9.62 format). (A)
# <code>SHA512(A)</code>. (B)
# <code>RIPEMD160(B)</code>. (C)
# Repeat step 1-4 until you have a result that starts with at least one zero. More zeros are permitted and cause a shorter address hash later. (D)
# Remove all zeros at the beginning of D. (E)
# <code>Address Version + Stream number + E</code>. (F)
# <code>SHA512(SHA512(F))</code>. Keep the first four bytes. (G)
# <code>F + G</code>. (H)
# <code>Base58_encode(H)</code>. (I)
# <code>"BM-" + I</code>. (J)

J is your full address. You want to store this together with privSign and privEnc somewhere.
Note: The secp256k1 public keys don't need to be stored because they can be recreated again later from the private keys.

== Deterministic address ==

Deterministic addresses are created by using the first 32 bytes of <code>SHA512(passphrase + var_int)</code> as private key instead of randomly generating one.
The var_int for the signing key starts at 0, and for the encryption key at 1.
On every failed attempt to create an address, increment both integers by two and repeat the attempt. This means the integer for the signing key is always even,
and the one for the encryption key always odd and one bigger than the signing key.

== Address validation ==

Remove the "BM-" at the beginning and Base58 decode the rest.
Remove the last 4 bytes from the decoded data. Calculate SHA512 of the remaining address bytes and check if the first 4 bytes of the hash match the trimmed off 4 bytes.

Optional additional test: The address should start with two var_int values.
Currently, only stream 1 is supported, and the address version should be 2-4.

== Remarks ==

Bitmessage's base58 encoding uses the following sequence (the same as Bitcoin's): "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz".
Many existing libraries for base58 do not use this ordering.

The BM- formatted address is never transmitted over the network. It's used to find the correct public key and decrypt it.

As you may have noticed, the address version and stream number are not part of the keys, this means it's technically possible to move an address between streams and versions, although the Base58 encoding makes the address look completely different each time.

The PyBitmessage client doesn't states how the passphrase is converted into bytes.
This means using "äöü" as a passphrase will deliver different results across different operating systems because of how strings in python are handled internally.

The entire hashing and leading zero restrictions only apply to the public signing key, not the encryption key.

Public key to bitmessage address

2022-08-03T22:46:53Z

AyrA: Add much more details

This page briefly describes, how to generate a Bitmessage Address from a public key.
The variable after each step in the list is used to refer to the step later.
Numbers used below are encoded as [[Protocol specification#Variable length integer|var_int]]

A <code>+</code> in this documentation means concatenation.

# Create two key pairs using secp256k1, one for encryption and one for signing (privEnc, pubEnc, privSign, pubSign)
# Merge keys together using <code>pubSign + pubEnc</code>. Be sure to use the uncompressed keys (64 bytes per key, X9.62 format). (A)
# <code>SHA512(A)</code>. (B)
# <code>RIPEMD160(B)</code>. (C)
# Repeat step 1-4 until you have a result that starts with at least one zero. More zeros are permitted and cause a shorter address hash later. (D)
# Remove all zeros at the beginning of D. (E)
# <code>Address Version + Stream number + E</code>. (F)
# <code>SHA512(SHA512(F))</code>. Keep the first four bytes. (G)
# <code>F + G</code>. (H)
# <code>Base58_encode(H)</code>. (I)
# <code>"BM-" + I</code>. (J)

J is your full address. You want to store this together with privSign and privEnc somewhere.
Note: The secp256k1 public keys don't need to be stored because they can be recreated again later from the private keys.

== Deterministic address ==

Deterministic addresses are created by using the '''last''' 32 bytes of <code>SHA512(passphrase + var_int)</code> as private key instead of randomly generating one.
The var_int for the signing key starts at 0, and for the encryption key at 1.
On every failed attempt to create an address, increment both integers by two and repeat the attempt. This means the integer for the signing key is always even,
and the one for the encryption key always odd and one bigger than the signing key.

== Address validation ==

Remove the "BM-" at the beginning and Base58 decode the rest.
Remove the last 4 bytes from the decoded data. Calculate SHA512 of the remaining address bytes and check if the first 4 bytes of the hash match the trimmed off 4 bytes.

Optional additional test: The address should start with two var_int values.
Currently, only stream 1 is supported, and the address version should be 2-4.

== Remarks ==

Bitmessage's base58 encoding uses the following sequence (the same as Bitcoin's): "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz".
Many existing libraries for base58 do not use this ordering.

The BM- formatted address is never transmitted over the network. It's used to find the correct public key and decrypt it.

As you may have noticed, the address version and stream number are not part of the keys, this means it's technically possible to move an address between streams and versions, although the Base58 encoding makes the address look completely different each time.

The PyBitmessage client doesn't states how the passphrase is converted into bytes.
This means using "äöü" as a passphrase will deliver different results across different operating systems because of how strings in python are handled internally.

The entire hashing and leading zero restrictions only apply to the public signing key, not the encryption key.

Talk:FAQ

2016-02-16T15:34:49Z

AyrA: Reverted edits by Lade (talk) to last revision by ChosenOne

In the comparison table "text only messages" is ambiguous, what does it mean? -ChosenOne

PyBitmessage Help

2015-11-25T10:50:22Z

AyrA: added image descriptions

Welcome to the help page for PyBitmessage.

[[File:Frontbitmessage.PNG|thumbnail|Main window in Windows 8 and newer]]

== Clarification ==
PyBitmessage is the official client, used as protocol reference. It is usually abbreviated "Bitmessage", causing confusion between the protocol and the client.

== Initial setup ==
PyBitmessage can be downloaded from the [[Main Page]], either as Windows binary or as source from github. Other builds (for example for Mac OS X) can be found in the forum.
The client sets up itself completely automatic. It can be launched and the required files for its operation are created if they do not exist.

== Daily usage ==
[[File:PyBitmessage-Sent.png|300px|thumb|right|Main window with sent tab open (Windows 7)]]
PyBitmessage will automatically connect to other clients on start up, the user does not needs to wait for this to complete and can instantly send messages. [[POW]] can be made if offline.
The Main interface contains the following tabs:

=== Inbox ===
The inbox contains all your received messages (top part) and displays the currently selected message (bottom part). The bottom window allows copying and editing the message but it will not be saved. The context menu in the message list provides additional features, such as [[HTML view]], save as text file and a reply option. Using the HTML view renders some HTML tags from the message, for example images.
Messages that are no longer needed can be sent to the trash with the [DEL] key.

=== Send ===
The "Send" tab is used to compose new private or [[Broadcast]] messages. A message can be dedicated to multiple people but the protocol supports only one receiving address per message. Example: Sending a message to 8 people will generate the exact same message 8 times in the "Sent" tab.

=== Sent ===
The sent tab displays messages sent by the user, including messages that are in the process of [[POW|proof of work]]. The status column displays the current status of the message.
Table with the most common messages:
{| class="wikitable" border="1"
|-
! Status
! Description
|-
| Doing work necessary to send <type>...
| [[POW]] is being done
|-
| <type> sent on <date/time>
| The message has been sent
|-
| Waiting on Acknowledgement
| The message has been sent but the receiver has not received it yet. Not applicable for broadcasts
|-
| Acknowledgement received on <date+time>
| The receiver got the message. Not applicable for broadcasts
|}
Messages can be sent to the trash with the [DEL] key however, this will not stop POW from being made if it has already started.

=== Your Identities ===
Contains a list of all addresses stored in [[keys.dat]] and allows to generate new ones. The context menu allows to enable/disable addresses. Addresses can be labeled, this label is then displayed instead of the address. Labels are not sent over the network and are only visible to the client. Addresses cannot be deleted directly in this tab, but removing the [[Address Block]] from keys.dat removes it. Editing the keys.dat file requires the user to shut down the client first.

=== [[Subscriptions]] ===
Contains a list of all [[Broadcast|broadcasts]], that the client will receive. To receive broadcasts its address must be added first to the list. The context menu allows enabling, disabling and deletation of addresses.

=== Address Book ===
Can be used to associate addresses with labels for easier recognition.
The context menu allows the user to add a subscription to the address.

=== Blacklist/Whitelist ===
Addresses can be blacklisted or whitelisted. The Operation mode of the list (whitelist or blacklist) ban be set too. The context menu allows entries to be enabled, disabled or deleted.

=== Network Status ===
Shows the [[Stream]] number and the number of connected nodes in a list. Displays when it was started and how much information has been processed yet.
Detailed information about the icon color and how to get a green icon can be found [[Network Status|here]]

== [[DML]] Addresses ==

[[File:Addchanbitmessage.PNG|thumbnail|Joining a DML by using passphrase and address]]

A DML Address can be either created or joined in the '''File > Join / Create chan''' menu.
These addresses are written with orange color in the identities tab.

To learn more about how to use a DML Address / chan, visit [[DML|this article]].
You need to either create the address or join it to send messages to it, else the client gets stuck when waiting for the public key. To resolve this issue, without joining or creating an address see, the DML article.

=== Join ===
To Join a DML, the address and the passphrase is required. The passphrase is used to generate the private keys, that the client needs to send and receive messages. The address is used so the user does not needs to know the stream number and address version. If the address is not known, a DML can be created, even if it actually exists, in the hope, that the resulting address is correct.

=== Create ===
Creating a DML/chan only requires a passphrase. It will create the address and mark it as such.

=== Notes ===
There is no technical difference between creation and joining. Joining requires the address to make sure, you actually get the correct private keys, because they depend on stream number and address version, which are both included in the address.
Creating an address however will always use the newest address version and stream number and thus may create a different address, which is not compatible with the one intended to join.

== Configuration ==
Bitmessage can be configured by editing [[keys.dat]] or by using the menu '''Settings > Settings''' in the GUI.

=== Settings Menu ===
The settings menu has the folowing tabs:

==== User Interface ====
Allows customization how bitmessage is started and if it should run in portable mode or not.

===== Willingly include... =====
'''Willingly include unencrypted destination address when sending to a mobile device'''

This option must be enabled, when using [[DML]] addresses and is a work in progress feature for mobile app support and has nothing to do with the user interface.

===== Interface language =====
This option is currently (at least in the compiled windows version) not fully working but allows to set the language of the client.

==== Network Settings ====
Allows setting of the TCP port used for incomming connections. This can be left at default value for most users.
A proxy server can be defined if the user wishes to do so. Supports SOCKS4a and SOCKS5 with Authentication support.
The option to allow incoming connections can be enabled if the user wishes to help the network, even when using a proxy. Incoming connections '''are not''' routed over the socks proxy!

==== Demanded Difficulty ====
The demanded difficulty allows to increase the amount of POW to be done for other clients to send messages to the user.
POW for users in the address book is always 1. Doubling the number doubles the amount of time required.

The value for small difficulty defaults to 1.0, rthe value for large difficulty to 2.0 (since version 0.4.0)

==== Max acceptable difficulty ====
Similar to the "demanded difficulty" tab, this tab has the exact same textboxes, however, they are used to limit the amount of POW the user is willing to do. If he sends a message and the destination address wants him to do more POW than he set as maximum, the message will not be processed. The user can click with the right mouse button on the message and force it to be sent or he can delete the message.

== Database cleanup ==
The database ([[messages.dat]]) can be cleaned and shrinked manually with the menu '''File > Delete all trashed messages'''.
The database is compacted once every month automatically without deletion of trashed messages.

== Statistics ==
=== Time ===
On an average computer, different processes take different amounts of time.
{| class="wikitable"
|-
! Action !! Time required
|-
| Generate an address || 1 second*
|-
| Generate an address (1 or 2 characters shorter) || 5 minutes*
|-
| Sender do work necessary to send broadcast|| 2 minutes
|-
| Sender do work necessary to send person-to-person message|| 4 minutes
|-
| message (or acknowledgement data) propagate through the network|| 10 seconds
|}
Note that on Linux and OSX systems, Bitmessage can often do work much faster as it is able to use all available cores and a faster hashing module.

<nowiki>*</nowiki> After this step is done, the client will silently do work to send out the public key over the network which will take about 2 minutes.

File:Addchanbitmessage.PNG

2015-11-23T07:44:35Z

AyrA: AyrA uploaded a new version of File:Addchanbitmessage.PNG

File:Frontbitmessage.PNG

2015-11-23T07:42:08Z

AyrA: AyrA uploaded a new version of File:Frontbitmessage.PNG

Lite Client Message Retrieval Proposal

2014-12-20T19:38:05Z

AyrA: added proposal note

{{Template:Proposal}}

== Introduction ==
This is a proposal to introduce a mechanism into the Bitmessage protocol that will allow 'lite' Bitmessage clients to retreive messages that have been sent to them without downloading all the messages in a stream.

== Summary of the proposal ==

* Lite clients can determine which messages they need to dowload using 'prefix filters'.
* Prefix filters allow the owner of each Bitmessage address to determine the balance between anonymity and efficiency that they will have when retrieving messages.
* Users who wish to retain the highest level of anonymity (by downloading all messages in a stream) are not affected by this change. Messages to them are 'tagged' with completely random data.
* Users who do not care about anonymity can specify a very precise prefix for each of their addresses, allowing them to download only messages destined for them.
* Other users can achieve a balance between anonymity and convenience.

== Reasoning behind the proposal ==

Currently, Bitmessage clients such as PyBitmessage act as full nodes in the Bitmessage peer-to-peer network. This involves transmitting, receiving, and processing a large amount of data. This workload may be manageable for more powerful devices, such as laptops, desktops, and servers, but it is typically too great for less powerful devices such as mobile phones and tablets to reasonably handle. This is particularly true in cases where mobile internet connections mean that bandwidth is very expensive. Because of this, a high proportion of the computing devices in use today are not suitable to act as full nodes in the Bitmessage peer-to-peer network. Therefore, in order for the users of these devices to be able to use Bitmessage, there must be some way of doing so that does not involve their device acting as a full node in the network.

One approach to solving this problem is the creation of 'lite' clients. These are Bitmessage clients which do not do all the processing and transmission work that full nodes do. Instead, the burden of this work is shifted to servers, which supply lite clients with the data they need and relay data sent by lite clients to the rest of the Bitmessage network. Thankfully the design of Bitmessage allows this to be implemented in such a way that very little security is lost. All message encryption and decryption can be done locally by the lite client, and it can retain sole control over its addresses and cryptographic keys. Data provided by servers can be cryptographically authenticated as being correct, and data sent to servers can be disseminated to several at once to ensure that it reaches the rest of the network.

However, this arrangement does require one significant compromise. In order for 'lite' clients such as mobile phones to receive messages, there needs to be some way for them to identify messages that have been sent to their addresses. Full nodes in Bitmessage do not require this because they receive and automatically attempt to decrypt all messages in the streams (segments of the network) which they are a part of. As described above however, the work required for this approach is too great for many devices, and therefore there must be some way for lite clients to identify which messages are destined for them, so that they can request those messages from a server.

== Proposed changes ==

The pubkey of every hashed address contains two new fields: a 'prefix length' field and a 'prefix' field. The value of the prefix length field is defined by the owner of the pubkey. The prefix field is set randomly. The value of the prefix length field defines what balance of efficiency and anonymity the owner of that address wants. If the value of the prefix length field is zero, then the prefix field can be ignored entirely, giving maximum anonymity. On the other extreme, if the value of the prefix length field is 32 (the maximum), then the full 32 bits of the prefix should be used, giving maximum efficiency in retrieving data. Each additional bit used halves the proportion of the total data set that you will have to request in order to receive data destined for you.

All msgs have a 'prefix nonce' as part of their unencrypted data. This prefix nonce is always of a fixed length (32 bits) to avoid leaking information. When sending a msg to an address, the sending client examines the destination address's pubkey and sets the first n bits of the prefix nonce to match the prefix found in the pubkey. The remainder of the prefix nonce is set randomly.

When a lite client wishes to retrieve msgs from the network, it makes a request to a server for all msgs which have a prefix nonce where the first n bits matches the prefix of the lite client's address(s).

=== Pubkey object ===
Under this proposal, the encrypted part of a pubkey object would be composed as follows. This can be compared to the current specification found at https://bitmessage.org/wiki/Protocol_specification#pubkey.

{|class="wikitable"
! Field Size !! Description !! Data type !! Comments
|-
|-
| 4||[[Protocol_specification#Pubkey_bitfield_features|behavior bitfield]]||uint32_t||A bitfield of optional behaviors and features that can be expected from the node receiving the message.
|-
| 1||prefix_length||uint8_t||The number of bits from the prefix value that should be used. Must be in the range 0-32.
|-
| 4||prefix||uint32_t||The prefix value. Contains 32 randomly set bits.
|-
| 64||public signing key||uchar[]||The ECC public key used for signing (uncompressed format; normally prepended with \x04 )
|-
| 64||public encryption key||uchar[]||The ECC public key used for encryption (uncompressed format; normally prepended with \x04 )
|-
| 1+||nonce_trials_per_byte||var_int||Used to calculate the difficulty target of messages accepted by this node. The higher this value, the more difficult the Proof of Work must be before this individual will accept the message. This number is the average number of nonce trials a node will have to perform to meet the Proof of Work requirement. 1000 is the network minimum so any lower values will be automatically raised to 1000.
|-
| 1+||extra_bytes||var_int||Used to calculate the difficulty target of messages accepted by this node. The higher this value, the more difficult the Proof of Work must be before this individual will accept the message. This number is added to the data length to make sending small messages more difficult. 1000 is the network minimum so any lower values will be automatically raised to 1000.
|-
| 1+||sig_length||var_int||Length of the signature
|-
| sig_length||signature||uchar[]||The ECDSA signature which covers everything from the object header starting with the time, then appended with the decrypted data down to the extra_bytes. <span style="color:red">This was changed in protocol v3. </span>
|}

=== Msg object ===
Under this proposal, a msg object would be composed as follows. This can be compared to the current specification found at https://bitmessage.org/wiki/Protocol_specification#msg.

{|class="wikitable"
! Field Size !! Description !! Data type !! Comments
|-
| 4||prefixNonce||uint32_t||The prefix nonce.
|-
| ?||encrypted||uchar[]||Encrypted data. See [[Protocol_specification#Encrypted_payload|Encrypted payload]]. See also [[Protocol_specification#Unencrypted_Message_Data|Unencrypted Message Data Format]]
|}

== Examples ==

===Example 1===
If Alice does not care about anonymity, she can have her address's pubkey specify that the full 32 bits of the prefix field should be used. This means that all msgs sent to her will effectively be uniquely tagged for her address (there are roughly 4 billion possible prefix values). This will allow Alice to only download msgs that are destined for her, giving her maximum usability and convenience at the expense of anonymity.

===Example 2===
If Bob wants to achieve a balance between anonymity and convenience, he can have his address's pubkey specify that 4 bits of the prefix field should be used, e.g 0110. This means that all msgs sent to his address will have a prefix nonce beginning with 0110. A random distribution of prefixes in a stream should mean that roughly 6.25% of msgs in a stream will have a prefix nonce beginning with 0110. Therefore Bob will be able to download roughly 6.25% of the msgs in a stream and still be guaranteed to receive all msgs destined for him.

===Example 3===
If Carol wants maximum anonymity then she can have her address's pubkey specify that zero bits of the prefix field should be used. This means that msgs sent to her will contain no identifying information, only a totally random prefix nonce. Carol will have to download and attempt to decrypt all msgs in a stream in order to be sure of receiving all msgs destined for her.

== Notes ==

===Other object types===
Prefix filtering is not required for broadcasts, pubkeys, or getpubkeys. These object types are already tagged with an identifier.

===Lite client pubkey retrieval===
How can lite clients retrieve pubkeys without telling the servers who they are talking to?<br>
In the short to medium term (until streams are implemented), it will be perfectly viable for lite clients to simply download all pubkeys in stream 1. A pubkey is 392 bytes in size. If we assume an average of 5 addresses per user, we could support a 10x increase in the number of active users (from roughly 1,000 to 10,000), and lite clients would still only have to download 19MB worth of pubkey data. This is only a rough approximation, but it seems reasonably clear that the amount of data to download and store would be acceptable.

===Lite client pubkey dissemination===
How can lite clients respond to getpubkey requests?<br>
Lite clients can do this in two ways:<br>
1. They can make periodic requests to full node servers to check for any getpubkeys for any of their addresses and then respond to any getpubkeys they receive by re-disseminating the relevant pubkeys. <br>
2. They can periodically re-disseminate the pubkeys for each of their addresses, with the re-dissemiantion period determined by the time to live of the pubkeys they create. This will ensure that the pubkeys for all the lite client's addresses are always available in the stream(s) they are a part of.

===Non-hashed addresses===
If non-hashed addresses are introduced in the future, this scheme will not apply to them, as they will not have pubkeys. Users of non-hashed addresses will still need to download and attempt to decrypt all msgs in each stream in which they have an address. This makes sense though, as the whole point of introducing non-hashed addresses is to give people the ability to choose greater anonymity at the expense of convenience.

Bitmessage Wiki:About

2014-10-19T15:17:54Z

AyrA: Protected "Bitmessage Wiki:About" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

This wiki is for the documentation, discussion, and development of the Bitmessage software.

Template:External

2014-10-19T11:12:18Z

AyrA: added forum tag

<div class="plainlinks" style="border: 1px solid #fa0; width: 50%; background-color: #fec; padding: 10px; margin-bottom: 25px">This page handles a 3rd party software that is not directly affilated with PyBitmessage. Please create your own wiki for your projects or use the forum.</div>
<includeonly>[[Category:Proposals]]</includeonly>

Bitseal

2014-10-19T11:11:45Z

AyrA: added external template

{{Template:External}}

Bitseal is a Bitmessage client for Android, currently in Beta.

== Bitseal Server ==

The Bitseal server code can be found at: (https://github.com/JonathanCoe/bitseal-server)

The Bitseal server application is a slightly modified version of PyBitmessage: (https://github.com/bitmessage/pybitmessage)

See also Bitseal's main respository: (https://github.com/JonathanCoe/bitseal)

=== Instructions for setting up bitseal-server ===

1) Download the zip file of the source code from Github

2) Extract the source code files to the desired location on your server

3) Run bitmessagemain.py

4) After a few seconds, stop PyBitmessage. PyBitmessage will have created a keys.dat file, which you can now use to specify your API settings

5) Open the keys.dat file. You can find its location using this reference: https://bitmessage.org/wiki/Keys.dat

6) Add the following lines to the "bitmessagesettings" section of the keys.dat file, replacing the port number, username, and password values as appropriate:

daemon = true <br>
apienabled = true <br>
apiport = YOUR_API_PORT_NUMBER <br>
apiinterface = 0.0.0.0 <br>
apiusername = YOUR_API_USERNAME <br>
apipassword = YOUR_API_PASSWORD <br>

7) Save and close the keys.dat file

8) Ensure that your server's firewall is set up allowing incoming + outgoing TCP connections on port 8444 (PyBitmessage default) and the API port you specified in the keys.dat file

9) Run bitmessagemain.py

10) Open Bitseal and add your server's URL, API username, and API password via the 'Server Settings' page

11) Done!

=== Bitseal Server API ===
Required arguments are denoted inside < and > Optional arguments are inside [ and ].
{|class="wikitable"
! Command !! Parameters !! On Success Returns !! On Failure Returns !! Description
|-
| add || <integer> <integer> || An integer which is the sum of the two parameters || An API error || Returns the sum of the integers. Used as a simple test of the API.
|-
| disseminateMsg || <messageHex> || 'Message disseminated successfully' || 'Message dissemination failed', or an API error || Takes a hex-encoded msg object and disseminates it to the rest of the Bitmessage network. The POW for the msg must have already been done.
|-
| disseminatePubkey || <pubkeyHex> || 'Pubkey disseminated successfully' || 'Pubkey dissemination failed', or an API error || Takes a hex-encoded pubkey object and disseminates it to the rest of the Bitmessage network. The POW for the pubkey must have already been done.
|-
| disseminateGetpubkey || <getpubkeyHex> || 'Getpubkey disseminated successfully' || 'Getpubkey dissemination failed', or an API error || Takes a hex-encoded getpubkey object and disseminates it to the rest of the Bitmessage network. The POW for the getpubkey must have already been done.
|-
| requestPubkey || <identifierHex> <addressVersion> || The hex-encoded pubkey object, formatted as a single object in a JSON array || 'No pubkeys found', or an API error || Takes an 'identifer' value and address version number and attempts to find a matching pubkey in the server's storage. The identifier value is ripe hash or the 'tag' of the pubkey which is being requested, depending on the address version of the pubkey. If a matching pubkey is found, it is returned to the client.
|-
| checkForNewMsgs || <streamNumber> <receivedSinceTime> <receivedBeforeTime> || A JSON array containing the hex-encoded msg objects || 'No msgs found', or an API error || Takes a stream number, a 'received since' time value, and a 'received before' time value and returns any msg objects which were received in that stream number at a time between the two provided values.
|-
|}

==== API errors ====

Here are the various error codes and messages you might see. Parts of the error messages in BLOCK_CAPITALS are variable fields that will change based on the data involved in the error.

{|class="wikitable"
! Error Number!! Message
|-
| 000 || API Error 000: 'I need NUMBER_OF_PARAMETERS parameters!'
|-
| 001 || API Error 001: 'Decode error - DECODE_EXCEPTION_MESSAGE. Had trouble while decoding string: YOUR_STRING'
|-
| 002 || API Error 002: 'The address version cannot be less than ADDRESS_VERSION_NUMBER'
|-
| 003 || API Error 003: 'Address versions above ADDRESS_VERSION_NUMBER are currently not supported'
|-
| 004 || API Error 004: 'The length of hash should be 20 bytes (encoded in hex and thus 40 characters).'
|-
| 005 || API Error 005: 'The length of tag should be 32 bytes (encoded in hex and thus 64 characters).'
|-
| 006 || API Error 006: 'The requested object was found, but its payload is above the maximum size limit. The size of the object payload is PAYLOAD_SIZE_IN_BYTES'
|-
|}

Template:External

2014-10-19T11:10:56Z

AyrA:

<div class="plainlinks" style="border: 1px solid #fa0; width: 50%; background-color: #fec; padding: 10px; margin-bottom: 25px">This page handles a 3rd party software that is not directly affilated with PyBitmessage. Please create your own wiki for your projects.</div>
<includeonly>[[Category:Proposals]]</includeonly>

Template:External

2014-10-19T11:09:59Z

AyrA: Created page with "<div class="plainlinks" style="border: 1px solid #ee0; width: 50%; background-color: #ffc; padding: 10px; margin-bottom: 25px">This page handles a 3rd party software that is n..."

<div class="plainlinks" style="border: 1px solid #ee0; width: 50%; background-color: #ffc; padding: 10px; margin-bottom: 25px">This page handles a 3rd party software that is not directly affilated with PyBitmessage. Please create your own wiki.</div>
<includeonly>[[Category:Proposals]]</includeonly>

Compiling instructions

2014-07-15T13:36:50Z

AyrA: Protected "Compiling instructions": Excessive vandalism ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

This page should help novice users run Bitmessage from the source code files.

= Linux =

== Resolve dependencies ==
{| class="wikitable" border="1" width="80%"
|-
! Distribuion
! Instructions
|-
! scope="row"| Debian-based
(Ubuntu, Raspbian, PiBang, others)
| <small>''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems]. Debian 7 "wheezy" works without problems.''</small>
sudo apt-get install python openssl git python-qt4
|-
! scope="row"| Arch Linux
|
sudo pacman -S python2 openssl git python2-pyqt4
|-
! scope="row"| Fedora
| <small>''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''
</small>
su -c 'yum install -y http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
su -c 'yum install -y python python-qt4 git openssl-compat-bitcoin-libs'

Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bashrc && source ~/.bashrc
Note for Fedora 20 users: Due to inconsistent behavior encountered by declaring the above variable globally, the following "wrapper script" will declare the LD_LIBRARY_PATH variable correctly and only when running bitmessage. Name the script something like "bitmessage", mark it as executable (probably something like 755) and put it in /usr/bin so it's accessible without the full path.
export LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}"
/home/<yourusername>/PyBitmessage/src/bitmessagemain.py > /dev/null 2>&1 &
|-
! scope="row"| Red Hat Enterprise Linux (RHEL)
| <small>''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''
</small>
su -c 'yum install -y http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
su -c 'yum install -y python python-qt4 git openssl-compat-bitcoin-libs'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bashrc && source ~/.bashrc
|}

== Download and run PyBitmessage ==
# Download the source code from github:<br /><code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>
# Run PyBitmessage:<br /><code>~/PyBitmessage/src/bitmessagemain.py</code>
Check the wiki for more information on how to run Bitmessage [https://bitmessage.org/wiki/Daemon as a daemon].

<small>If you receive a warning that you need to use python 2.7.5 or greater, and have followed the above instructions to upgrade it, your system may be attemping to run PyBitmessage with python 3. In this case, run <code>python2 ~/PyBitmessage/src/bitmessagemain.py</code></small>

== Upgrading ==
To upgrade Bitmessage run the following commands:
:<code>cd $HOME/PyBitmessage</code>
:<code>git pull</code>

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

; Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
Read the instructions or take this as a reminder: Apple's XCode and their Command Line Tools are a prerequiste for Macports, go: https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.5 from [http://www.python.org/download/releases/2.7.5/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
## Test that it installed:
### Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
### type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
### If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
#### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
#### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
#### Close the command prompt window and reopen it.
### Try running 'python' again.
###Press Ctrl-Z to exit Python.
# Download PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. ''PyQt is one of Bitmessage's two dependencies.'' Look for the links to downloads under the heading labeled "Binary Package;" the binary package versions are already compiled for you. Select the version for Python 2.7 (look for "Py2.7" in the file name). Install PyQt.
# Download OpenSSL from [http://slproweb.com/products/Win32OpenSSL.html here]. ''OpenSSL is the second of Bitmessage's two dependencies.'' Install OpenSSL. If an error message appears during installation of OpenSSL, download and install Visual C++ 2008. A link is provided on the OpenSSL download page.
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Optionally also include the translations by modifying this file further by adding the lines shown in [[Example_pyinstaller_spec_file|this]] example file.
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2014-07-15T13:36:23Z

AyrA: Undo revision 24487 by Rajeshdhnashire (talk)

Keys.dat options

2014-05-02T23:25:10Z

AyrA: added table.

This page lists the extra 'hidden' options of which you can make use by adding them to your [[keys.dat]] file in the bitmessagesettings section. These options are either not set by default or are not documented at all.



== Possible options ==

{|class="wikitable"
! Version !! Name !! Values !! Documentation !! Description
|-
| ? || trustedpeer || IP:Port || undocumented || Connect to the specified node and only the specified node. Useful if you trust a node on your local network and want to sync to it quickly. Disallows incoming connections. Disables the built-in timing attack mitigation mechanism.
|-
| 0.2.7 || apienabled || true/false || [[API|API Reference]] || Turns the [[API]] on or off
|-
| 0.2.7 || apiport || number || [[API|API Reference]] || Port number to listen on (0-65535)
|-
| 0.2.7 || apiinterface || IP || [[API|API Reference]] || IP address of a local interface. 127.0.0.1 for localhost only access and 0.0.0.0 for all interfaces.
|-
| 0.2.7 || apiusername || string || [[API|API Reference]] || Username to access the API
|-
| 0.2.7 || apipassword || string || [[API|API Reference]] || password to access the API
|}

== enabling options ==
To enable an option, the [[keys.dat]] must be edited.
Lines of the format
<pre>name = Value</pre>
can be added. '''Please be aware of the spacing around the equal sign'''

Keys.dat

2014-05-02T23:16:01Z

AyrA: added more option documentation

keys.dat is a mixture of Bitmessage configuration and [[Address Block|Address blocks]]. It should be protected since it contains sensitive data that can be abused to impersonate others.

== Location ==
The file is located in the bitmessage directory (if run in portable mode).
On a Windows system in non-portable mode it is in the [http://en.wikipedia.org/wiki/Special_Folders#File_system_directories AppData] and can be reached by typing '''%APPDATA%\PyBitmessage''' in the windows explorers address bar. (Windows Explorer, not Internet Explorer)

Under Linux it is found in the users home directory: ~/.config/PyBitmessage

Under OSX it is found in the users home directory: ~/Library/Application Support/PyBitmessage

== Configuration ==
The keys.dat contains multiple sections:

=== [DEFAULT] and [bitmessagesettings] ===
Example Configuration
<pre>
[DEFAULT]
label = unused address

[bitmessagesettings]
settingsversion = 5
port = 8444
timeformat = %%a, %%d %%b %%Y %%I:%%M %%p
blackwhitelist = black
startonlogon = False
minimizetotray = True
showtraynotifications = False
startintray = False
socksproxytype = none
sockshostname = localhost
socksport = 9050
socksauthentication = False
socksusername = USER
sockspassword = PASS
keysencrypted = false
messagesencrypted = false
apienabled = true
apiport = 8442
apiinterface = 127.0.0.1
apiusername = API-Username
apipassword = API-Password
defaultnoncetrialsperbyte = 320
defaultpayloadlengthextrabytes = 14000
</pre>

The [[API_Reference|API settings]] are not present by default.
The section may additionally contain a [[Daemon]] entry.

=== Address Sections ===
The keys.dat contains sections, called [[Address Block|address blocks]].

== Hidden options ==
Some options are either not documented or are not set by default. These can be found on the [[keys.dat options]] page.

== Editing ==
Editing requires shutdown of the client first or changes may be overwritten again by the client.
All fields (except the '''DEFAULT''' section) can be edited in the clients settings dialog. changes can prevent the client from loading or addresses from working and should be taken with care. The keys.dat can be edited in any text editor and has to be saved back as raw text file, rendering office applications rather complicated to use. On windows, [http://en.wikipedia.org/wiki/Notepad_(software) notepad.exe] can be used for this purpose. Notepad can be opened and then the file can be loaded either by using '''File > Open''' or dragging it into the editor.

== Deleting ==
Deleting the keys.dat renders all addresses generated unusable and causes the client to revert to its default sections.
Messages that were received prior to deletation remain in the [[messages.dat]] file and are still readable.

== Debugging ==
Instead of deleting, removing of entries is recommended, using the following steps:
* Create a copy of keys.dat in case something rouls up.
* Delete the file and restart bitmessage.
* Close bitmessage, open the newly generated keys.dat and add a message block from the backup.
* Restart bitmessage, if it works, continue adding address blocks.
* If bitmessage no longer works, the invalid message block should be removed from keys.dat and be sent to atheros (on github or the forum) for further debugging.

[[Category:DAT Files]]

Template:Proposal

2014-05-02T23:01:52Z

AyrA: changed text

<div class="plainlinks" style="border: 1px solid #ee0; width: 50%; background-color: #ffc; padding: 10px; margin-bottom: 25px">This page is a proposal or recommendation. Its content is most likely not representing an actual situation.</div>

Mobile Protocol specification

2014-04-27T22:02:08Z

AyrA: added headers

{{Template:Stub}}

{{Template:Proposal}}

This is a DRAFT for protocol extensions to enable mobile devices to participate in bitmessage communication.

=== intension ===

if you want to let mobile devices participate in bitmessage communication, you need a gateway device. Theoretically the device could participate like a standard node, but this will cause too much traffic. Even if you have a flat rate, it'll cost to much battery.
This page describes a way, the standard protocol could be enhanced, to let mobile devices participate, at least through a gateway.

=== the gateway ===

The gateway first of all is a standard bitmessage node. As a bitmessage node it connects to other nodes and collects and exchanges objects. The mobile gateway functionality is an extension, an additional protocol variant.

When a mobile device connects to a gateway it will identify itself in the "services" field of the version message to be a mobile device. The gateway will answer in the same field, that it is a gateway.

Therefore the service table has to be enhanced:

{|class="wikitable"
! Value !! Name !! Description
|-
| 1 || NODE_NETWORK || This is a normal network node.
|-
| 2 || NODE_MOBILE || This is a mobile device with limited bandwidth.
|-
| 4 || NODE_GATEWAY || This node can send reduced traffic and work as a gateway.
|}

=== The differences in protocol behavior ===

==== sending messages ====

When accessed by a NODE_MOBILE the NODE_GATEWAY will not send any "addr" message, because the NODE_MOBILE will connect to the bitmessage network only through well known gateways. It will neither send a "inv" message, because it wants to reduce the traffic to the NODE_MOBILE.

When accessed to a NODE_GATEWAY the NODE_MOBILE will not send a "addr" message, too. But it might send an "inv" message, when it has objects to share. and it can share already all types of objects with the network.

With this very small protocol changes the NODE_MOBILE is already able to send messages using the bitmessage protocol, but with very reduced traffic load.

==== receiving messages ====

For the receive direction we must bring the NODE_GATEWAY in the position to select the objects the NODE_MOBILE is interested in.
Whenever the NODE_GATEWAY notifies, that NODE_MOBILE might be interested in objects, it sends a "inv" message to offer them (must only the objects, NODE_MOBILE is interested in!).

How does NODE_GATEWAY know, which objects are of interest. There are different possibilities to notify this. First of all: every "getpubkey" object is translated into a request. When the object arrives at NODE_GATEWAY or if its already there, it is offered in an "inv" message.

For "msg" and "broadcast" objects it's a little more complicate, because the NODE_GATEWAY has to make the decision. We must add an encrypted method, how the NODE_GATEWAY can get the secret keys of NODE_MOBILE.

Template:Proposal

2014-04-27T22:01:19Z

AyrA: Created page with "<div class="plainlinks" style="border: 1px solid #ee0; width: 50%; background-color: #ffc; padding: 10px; margin-bottom: 25px">This page is a proposal or recommendation. Its c..."

Main Page

2014-03-20T23:03:26Z

AyrA: I tried to find out, why the wiki was blank and reverted some changes.

<br />
__NOTOC__
{{Infobox
|name=Bitmessage
|downloadsite=https://bitmessage.org/download/windows/Bitmessage.exe
|release caption=Current version (Beta)
|latest release date=January 25, 2014
}}
Bitmessage is a P2P communications [[Protocol specification|protocol]] used to send encrypted messages to another person or to many subscribers. It is decentralized and trustless, meaning that you need-not inherently trust any entities like root certificate authorities. It uses strong authentication which means that the sender of a message cannot be spoofed, and it aims to hide "non-content" data, like the sender and receiver of messages, from passive eavesdroppers like those running warrantless wiretapping programs. If Bitmessage is completely new to you, you may wish to start by reading the [https://bitmessage.org/bitmessage.pdf whitepaper].

=== Download ===
An open source client is available for free under the very liberal [http://opensource.org/licenses/mit-license.php MIT license]. For screenshots and a description of the client, see this CryptoJunky article: [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ "Setting Up And Using Bitmessage"].

[[File:windows_icon.png|link=https://bitmessage.org/download/windows/Bitmessage.exe]] [https://bitmessage.org/download/windows/Bitmessage.exe Download for Windows]

[[File:apple_icon.png|link=https://bitmessage.org/download/osx/Bitmessage.dmg]] [https://bitmessage.org/download/osx/Bitmessage.dmg Download for OS X]

[[File:tux.png|link=Compiling_instructions]] [[Compiling instructions|Run the source code]]

Here is a simple echo server which will send your message back to you after being received: BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb

=== Source code ===
You may view the Python [https://github.com/Bitmessage/PyBitmessage source code on Github]. Bitmessage requires PyQt and OpenSSL. Step-by-step instructions on how to run the source code on Linux, Windows, or OSX is [[Compiling instructions|available here]].

=== Security audit needed ===
Bitmessage is in need of an independent audit to verify its security. If you are a researcher capable of reviewing the source code, please [https://bitmessage.org/misc/emailaddress.png email] the lead developer. You will be helping to create a great privacy option for people everywhere!

=== Forum ===
* Visit or subscribe to the [https://pay.reddit.com/r/bitmessage Bitmessage subreddit].
* A community-based forum for questions, feedback, and discussion is also available at [https://bitmessage.org/forum Bitmessage.org/forum].

Main Page

2014-03-20T23:01:13Z

AyrA: Reverted edits by Atheros (talk) to last revision by AyrA

<br />
__NOTOC__
{{Infobox
|name=Bitmessage
|downloadsite=https://bitmessage.org/download/windows/Bitmessage.exe
|release caption=Current version (Beta)
|latest release date=October 10, 2013
}}
Bitmessage is a P2P communications [[Protocol specification|protocol]] used to send encrypted messages to another person or to many subscribers. It is decentralized and trustless, meaning that you need-not inherently trust any entities like root certificate authorities. It uses strong authentication which means that the sender of a message cannot be spoofed, and it aims to hide "non-content" data, like the sender and receiver of messages, from passive eavesdroppers like those running warrantless wiretapping programs. If Bitmessage is completely new to you, you may wish to start by reading the [https://bitmessage.org/bitmessage.pdf whitepaper].

=== Download ===
An open source client is available for free under the very liberal [http://opensource.org/licenses/mit-license.php MIT license]. For screenshots and a description of the client, see this CryptoJunky article: [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ "Setting Up And Using Bitmessage"].

[[File:windows_icon.png|link=https://bitmessage.org/download/windows/Bitmessage.exe]] [https://bitmessage.org/download/windows/Bitmessage.exe Download for Windows]

[[File:apple_icon.png|link=https://bitmessage.org/download/osx/Bitmessage.dmg]] [https://bitmessage.org/download/osx/Bitmessage.dmg Download for OS X]

[[File:tux.png|link=Compiling_instructions]] [[Compiling instructions|Run the source code]]

Here is a simple echo server which will send your message back to you after being received: BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb

=== Source code ===
You may view the Python [https://github.com/Bitmessage/PyBitmessage source code on Github]. Bitmessage requires PyQt and OpenSSL. Step-by-step instructions on how to run the source code on Linux, Windows, or OSX is [[Compiling instructions|available here]].

=== Security audit needed ===
Bitmessage is in need of an independent audit to verify its security. If you are a researcher capable of reviewing the source code, please [https://bitmessage.org/misc/emailaddress.png email] the lead developer. You will be helping to create a great privacy option for people everywhere!

=== Forum ===
* Visit or subscribe to the [https://pay.reddit.com/r/bitmessage Bitmessage subreddit].
* A community-based forum for questions, feedback, and discussion is also available at [https://bitmessage.org/forum Bitmessage.org/forum].

Decentralized Mailing List

2014-01-08T13:42:55Z

AyrA: /* Usage */ expanded DML usage

A [[Mailing List]] without the requirement of a central "authority". Sometimes called Chan (short for channel) because they usually focus on a subject which also is the password for the deterministic address too.

== Issues with regular Mailing Lists ==
Despite the fact that Bitmessage is a decentralized [[p2p]] network, pseudo-mailing lists require the client who operates the list to be online, creating a [http://en.wikipedia.org/wiki/Single_point_of_failure Single Point of Failure]. Decentralized lists circumvent this issue by having a group of users share private keys. Users may optionally send messages from the decentralized mailing list identity address itself. Decentralized lists cannot be clogged up with large messages because the [[POW]] is only done by the sending client.

== Creation ==
A DML can be created in the File menu with the Option "Join / Create chan". A Passphrase must be entered and the address is generated.

== Joining ==
A DML can be joined in the File menu with the Option "Join / Create chan". A Passphrase and the address must be entered.

== Notes ==
There is no technical difference between creation and joining a DML. Joining requires the address to make sure that you typed the DML name correctly and to make sure that you are using the correct stream number and address version which are included in the address and serves as an error check for the client. If the address is not available, the user can create the DML instead of joining it with the same effect.

== Incompatibilities ==
* You cannot use the n-th address or generate short addresses with the create/join dialog. You can do so when generating a deterministic address but it will not be recognized as DML.
* You cannot send messages to a DML if you are not member. This is caused by the fact, that a DML address does not publishes its public key.

== Circumvent stuck client ==
To circumvent non-members of getting stuck, a user can create a deterministic address with the same configuration as the DML Address (provided he hasn't the DML already in his identities), this address will answer key requests and non-members world wide can use the DML.

== Usage ==
To properly use a DML, a user can
* Write from the DML, to the DML: This is completely anonymous and is the default behavior. Some users however tend to block the DML address itself using the blacklist to reduce spam.
* Write from a personal address to the DML: can be used to "sign" messages with the private address so nobody can claim it was he, who sent it. Also useful if people block the DML address itself (see point above)
* Write from a DML to a personal address: This can be used, if the user thinks the response might be useful for members of the given DML.

== Issues with Decentralized Mailing Lists ==
* Since all users share the same address it cannot be easily verified, who sent a message.
* Spam cannot be blocked on address base, since everyone shares the same sender address.
* Non-Members cannot write to a DML
* Users are easier deanonymized when using DML addresses using simple network monitoring.

== Updating ==
If a user was a member of a DML before 0.3.5 came out, he might want to update the address to a DML.
To do so, first of all the subscription needs to be removed in the GUI, after that, the [[keys.dat]] needs to be edited and the line "chan = true" needs to be inserted into the address block that should be a DML.

== Example Address ==
Passphrase: '''general''', Address: '''BM-2DAV89w336ovy6BUJnfVRD5B9qipFbRgmr'''.
The [[Address Block]] of a DML should look like this (it may have additional entries):

<pre>
[BM-2DAV89w336ovy6BUJnfVRD5B9qipFbRgmr]
label = general
enabled = true
decoy = false
chan = true
privsigningkey = 5Jnbdwc4u4DG9ipJxYLznXSvemkRFueQJNHujAQamtDDoX3N1eQ
privencryptionkey = 5JrDcFtQDv5ydcHRW6dfGUEvThoxCCLNEUaxQfy8LXXgTJzVAcq
</pre>

== Address List ==
A list of addresses can be found at [https://bitmessage.org/forum/index.php/topic,1420.0.html the forum].

[[Category:Address terms]]

Decentralized Mailing List

2014-01-08T13:39:11Z

AyrA: /* Notes */ better description

A [[Mailing List]] without the requirement of a central "authority". Sometimes called Chan (short for channel) because they usually focus on a subject which also is the password for the deterministic address too.

== Issues with regular Mailing Lists ==
Despite the fact that Bitmessage is a decentralized [[p2p]] network, pseudo-mailing lists require the client who operates the list to be online, creating a [http://en.wikipedia.org/wiki/Single_point_of_failure Single Point of Failure]. Decentralized lists circumvent this issue by having a group of users share private keys. Users may optionally send messages from the decentralized mailing list identity address itself. Decentralized lists cannot be clogged up with large messages because the [[POW]] is only done by the sending client.

== Creation ==
A DML can be created in the File menu with the Option "Join / Create chan". A Passphrase must be entered and the address is generated.

== Joining ==
A DML can be joined in the File menu with the Option "Join / Create chan". A Passphrase and the address must be entered.

== Notes ==
There is no technical difference between creation and joining a DML. Joining requires the address to make sure that you typed the DML name correctly and to make sure that you are using the correct stream number and address version which are included in the address and serves as an error check for the client. If the address is not available, the user can create the DML instead of joining it with the same effect.

== Incompatibilities ==
* You cannot use the n-th address or generate short addresses with the create/join dialog. You can do so when generating a deterministic address but it will not be recognized as DML.
* You cannot send messages to a DML if you are not member. This is caused by the fact, that a DML address does not publishes its public key.

== Circumvent stuck client ==
To circumvent non-members of getting stuck, a user can create a deterministic address with the same configuration as the DML Address (provided he hasn't the DML already in his identities), this address will answer key requests and non-members world wide can use the DML.

== Usage ==
To properly use a DML, a user can
* Write from the DML, to the DML: This is completely anonymous and is the default behaviour that should be taken.
* Write from a personal address to the DML: This can be used so answers given to the message will only be sent to the private address and not to the DML, or it can be used to "sign" messages with the private adress so nobody can claim it was he, who sent it.

== Issues with Decentralized Mailing Lists ==
* Since all users share the same address it cannot be easily verified, who sent a message.
* Spam cannot be blocked on address base, since everyone shares the same sender address.
* Non-Members cannot write to a DML
* Users are easier deanonymized when using DML addresses using simple network monitoring.

== Updating ==
If a user was a member of a DML before 0.3.5 came out, he might want to update the address to a DML.
To do so, first of all the subscription needs to be removed in the GUI, after that, the [[keys.dat]] needs to be edited and the line "chan = true" needs to be inserted into the address block that should be a DML.

== Example Address ==
Passphrase: '''general''', Address: '''BM-2DAV89w336ovy6BUJnfVRD5B9qipFbRgmr'''.
The [[Address Block]] of a DML should look like this (it may have additional entries):

<pre>
[BM-2DAV89w336ovy6BUJnfVRD5B9qipFbRgmr]
label = general
enabled = true
decoy = false
chan = true
privsigningkey = 5Jnbdwc4u4DG9ipJxYLznXSvemkRFueQJNHujAQamtDDoX3N1eQ
privencryptionkey = 5JrDcFtQDv5ydcHRW6dfGUEvThoxCCLNEUaxQfy8LXXgTJzVAcq
</pre>

== Address List ==
A list of addresses can be found at [https://bitmessage.org/forum/index.php/topic,1420.0.html the forum].

[[Category:Address terms]]

Decentralized Mailing List

2014-01-08T13:28:08Z

AyrA: /* Issues with Decentralized Mailing Lists */ deanonymization hint added.

A [[Mailing List]] without the requirement of a central "authority". Sometimes called Chan (short for channel) because they usually focus on a subject which also is the password for the deterministic address too.

== Issues with regular Mailing Lists ==
Despite the fact that Bitmessage is a decentralized [[p2p]] network, pseudo-mailing lists require the client who operates the list to be online, creating a [http://en.wikipedia.org/wiki/Single_point_of_failure Single Point of Failure]. Decentralized lists circumvent this issue by having a group of users share private keys. Users may optionally send messages from the decentralized mailing list identity address itself. Decentralized lists cannot be clogged up with large messages because the [[POW]] is only done by the sending client.

== Creation ==
A DML can be created in the File menu with the Option "Join / Create chan". A Passphrase must be entered and the address is generated.

== Joining ==
A DML can be joined in the File menu with the Option "Join / Create chan". A Passphrase and the address must be entered.

== Notes ==
There is no technical difference between creation and joining a DML. Joining requires the address to make sure that you typed the DML name correctly and to make sure that you are using the correct stream number and address version which are included in the address.

== Incompatibilities ==
* You cannot use the n-th address or generate short addresses with the create/join dialog. You can do so when generating a deterministic address but it will not be recognized as DML.
* You cannot send messages to a DML if you are not member. This is caused by the fact, that a DML address does not publishes its public key.

== Circumvent stuck client ==
To circumvent non-members of getting stuck, a user can create a deterministic address with the same configuration as the DML Address (provided he hasn't the DML already in his identities), this address will answer key requests and non-members world wide can use the DML.

== Usage ==
To properly use a DML, a user can
* Write from the DML, to the DML: This is completely anonymous and is the default behaviour that should be taken.
* Write from a personal address to the DML: This can be used so answers given to the message will only be sent to the private address and not to the DML, or it can be used to "sign" messages with the private adress so nobody can claim it was he, who sent it.

== Issues with Decentralized Mailing Lists ==
* Since all users share the same address it cannot be easily verified, who sent a message.
* Spam cannot be blocked on address base, since everyone shares the same sender address.
* Non-Members cannot write to a DML
* Users are easier deanonymized when using DML addresses using simple network monitoring.

== Updating ==
If a user was a member of a DML before 0.3.5 came out, he might want to update the address to a DML.
To do so, first of all the subscription needs to be removed in the GUI, after that, the [[keys.dat]] needs to be edited and the line "chan = true" needs to be inserted into the address block that should be a DML.

== Example Address ==
Passphrase: '''general''', Address: '''BM-2DAV89w336ovy6BUJnfVRD5B9qipFbRgmr'''.
The [[Address Block]] of a DML should look like this (it may have additional entries):

<pre>
[BM-2DAV89w336ovy6BUJnfVRD5B9qipFbRgmr]
label = general
enabled = true
decoy = false
chan = true
privsigningkey = 5Jnbdwc4u4DG9ipJxYLznXSvemkRFueQJNHujAQamtDDoX3N1eQ
privencryptionkey = 5JrDcFtQDv5ydcHRW6dfGUEvThoxCCLNEUaxQfy8LXXgTJzVAcq
</pre>

== Address List ==
A list of addresses can be found at [https://bitmessage.org/forum/index.php/topic,1420.0.html the forum].

[[Category:Address terms]]

Template:Missing

2013-12-20T13:39:19Z

AyrA: changing -> creating

<div class="plainlinks" style="border: 1px solid #ee0; width: 50%; background-color: #ffc; padding: 10px; margin-bottom: 25px">This part is '''missing''', you can help by [{{fullurl:{{FULLPAGENAME}}|action=edit}} creating it].</div>
<includeonly>[[Category:Stubs]]</includeonly>

Template:Missing

2013-12-20T13:38:39Z

AyrA: made it shorter

<div class="plainlinks" style="border: 1px solid #ee0; width: 50%; background-color: #ffc; padding: 10px; margin-bottom: 25px">This part is '''missing''', you can help by [{{fullurl:{{FULLPAGENAME}}|action=edit}} expanding it].</div>
<includeonly>[[Category:Stubs]]</includeonly>

TOR

2013-12-20T13:37:09Z

AyrA: changed "N/A" to "missing" template

{{Stub}}

TOR (''The Onion Routing'') is a network which allows users to browse the internet anonymously and securely.
This Page gives instructions on how to set up a TOR router for bitmessage.

== Windows ==
These instructions are for AdvOR, which is one of the most advanced TOR clients.

=== Obtaining a tor client ===
The client can be downloaded from sourceforge: [http://sourceforge.net/projects/advtor/ Download].

Download and extract the zip file to any location and launch the exe inside it.
The TOR client is fully portable and can be put on a USB flash drive with bitmessage.

=== Configuring the client ===
This is optional. On the top left corner of the client, click on "Proxy".
You can obtain and change the listening Port and address for your router if you wish.
In this guide the Port 9050 on address 127.0.0.1 is used.

On the left side menu, click on "System" and enable "Connect Automatically" and "Minimize at startup".
This way the client cannot easily be spotted by others and works silently.

=== Configuring Bitmessage ===
Refer to the [[FAQ#How do I setup Bitmessage to work with Tor|FAQ]].
Use the IP and port from your client, if they differ from the manual.

== Linux ==
{{Missing}}
=== Obtaining a tor client ===
{{Missing}}
=== Configuring the client ===
{{Missing}}
=== Configuring Bitmessage ===
Refer to the [[FAQ#How do I setup Bitmessage to work with Tor|FAQ]].
Use the IP and port from your client, if they differ from the manual.

== OSX ==
{{Missing}}
=== Obtaining a tor client ===
{{Missing}}
=== Configuring the client ===
{{Missing}}
=== Configuring Bitmessage ===
Refer to the [[FAQ#How do I setup Bitmessage to work with Tor|FAQ]].
Use the IP and port from your client, if they differ from the manual.

Template:Missing

2013-12-20T13:36:20Z

AyrA: Created 'missing' template for parts

<div class="plainlinks" style="border: 1px solid red; width: 100%; background-color: #ffc; padding: 10px; margin-bottom: 25px;">This part is '''missing''', you can help by [{{fullurl:{{FULLPAGENAME}}|action=edit}} expanding it].</div>
<includeonly>[[Category:Stubs]]</includeonly>

FAQ

2013-12-20T13:34:17Z

AyrA: /* How do I setup Bitmessage to work with Tor */ changed quick instructions for TOR

==Installation and configuration==
===How do I install Bitmessage===
Bitmessage does not needs to be "installed". it is simply downloaded and executed. You can find instructions to download and run bitmessage from the [[Main Page]].
A great write up for setting up and using Bitmessage on Windows can be found [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ Here.]

Bitmessage should run on any OS though it is only lightly tested on OSX. The start-on-boot and minimize-to-tray features are only implemented for Windows thus far. Several examples of how to install Bitmessage on *nix and OSX platforms can be found [https://bitmessage.org/forum/index.php in the forums.]

===How do I become a node to help the network===
If your connection indicator is green then you are already accepting incoming connections and helping the Bitmessage network.

If your connection indicator is yellow, check your firewall settings and port forwarding to make sure incoming connections are allowed to your machine on the correct TCP port (Default: 8444), the port can be found in the Bitmessage settings.

You can click on the indicator for more information about each color.

===Why is my Connection Indicator Yellow===
Bitmessage will work normally with a yellow indicator. If your indicator is yellow, you can have up to 8 connections. To make your indicator green, please forward the required TCP port (usually 8444). You can find the Port in the Bitmessage settings.

===How do I setup Bitmessage to work with Tor===
If you need a TOR client, more complete instructions can be found on the [[TOR]] page.
If you already have a client, follow the instructions below.

'''Tor'''

If you are using the Tor Browser Bundle skip to the next section. In order for Bitmessage to use Tor as a proxy follow these steps.
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9050'.
*Select ok.
*Restart Bitmessage.

'''Tor Browser Bundle'''
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9150'.
*Select ok.
*Restart Bitmessage.

==Usage==
===How can I run Bitmessage in daemon mode===
Refer to the [[Daemon|Daemon Mode Page]].

===How many connections should I have===
As long as you have at least one connection, you can communicate with the network. If your connection indicator is yellow, you can have a maximum of 8 connections.

===Can I send a message to someone that is offline===
Yes. However, if you go offline then they must come back online within 2 days of the message being sent. Nodes delete data, and do not accept data, older than 2 days.

===How do I format my messages===
Here is [https://qt-project.org/doc/qt-4.8/richtext-html-subset.html the list of supported HTML tags].

===What are subscriptions?===

A [[Subscriptions|subscription]] allows you to receive messages, that were broadcasted by the address you subscribe too.
Since [[broadcast]] messages are encrypted with a key, that can be created by everyone who knows the address, you must be subscribed to an address to actually read the messages.

Subscriptions are also required to use a [[Mailing List]].

===What are "chans"?===
Chan is another word for DML. Please refer to [[DML|this article]] for a complete documentation of this rather complex feature.

==How does Bitmessage work==
'''Startup'''

When you first start Bitmessage, your client connects itself to the network and starts downloading a list of known nodes. Each new node that you connect to shares its list of known nodes. In addition to the known nodes, you will also start receiving person-to-person messages, broadcasts, and public keys. If any of these messages are bound for you, they will be shown in your inbox. All of this data is exchanged between all of your connections to make sure that everyone has a copy.

'''Sending a Message'''

When you send a message, your client must first compute a Proof of Work (POW). This POW helps mitigate spam on the network. Nodes and other clients will not process your message if it does not show sufficient POW. After the POW is complete, your message is shared to all of your connections which in turn share it with all of their connections.

===Where can I find more documentation about Bitmessage===
* [https://bitmessage.org/bitmessage.pdf Overview White Paper (PDF)]
* [[Protocol specification]]
* Detail about the [[Proof of work]]

==How does Bitmessage compare to other messaging methods==
Here is a table comparing Bitmessage to other common messaging services.

{| border="1" class="wikitable"
|+ Comparison of Messaging Services
!  
! Trustless
! P2P
! Open Source
! Requires Proof of Work
! Hide Sender?
! Hide Receiver?
! Mobile Version
! Application or Web Based
! Text Only Messages
! Attachments
! Acknowledge delivery
! Asynchronous
! OTR
|-
! Bitmessage
| {{Yes}}
| {{Yes}}
| [http://opensource.org/licenses/mit-license.php MIT]
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{No}}
| {{Yes|180 MB}}
| {{Yes}}
|-
! Standard Email
|
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{No}}
| {{Yes}}
| {{Partial}}
|-
! Email + GPG
| {{Yes}}
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{Yes}}
| {{Partial}}
|-
! [http://xmpp.org/ XMPP] + [https://en.wikipedia.org/wiki/Off-the-Record_Messaging OTR]
| {{Yes}}
| {{No}}
| {{Yes|GPL V2.1}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [http://www.skype.com/en/ Skype]
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [http://www.scayl.com/ Scayl]
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes|Alpha}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/I2P#E-mail I2P Bote]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL V3}}
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
! [https://crypto.cat/ CryptoCat]
| {{No}}
| {{No}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC]
|
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! SMS
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [http://retroshare.sourceforge.net/ RetroShare]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
|
|
|
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/Freenet#Tools_and_applications Freenet + Frost]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + FMS]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + Freemail] 0.2
| {{No}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [https://wiki.freenetproject.org/FLIP Freenet + FLIP]
| {{Yes}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|}

==Troubleshooting==
===My Connection Indicator is Red===
Check your connection settings.
Check if you can access the internet. In case you have a firewall with outgoing restrictions (not Windoes firewall) allow unrestricted access for Bitmessage through your firewall.
Sometimes Bitmessage takes time to connect to the network, especially if [[knownnodes.dat]] is large. Please allow at least 30 minutes for it to connect before posting to the forum.
You can also try deleting [[knownnodes.dat]].

If none of that works, [https://bitmessage.org/forum/index.php please visit the forum here.]

===I have not received a reply from the Echo Server===
*Your connection indicator should be yellow or green.
*Make sure that your POW is complete and the message has been sent. You should see an acknowledgement under "Status" on the "Sent" tab.
*On average it should take 8 minutes from the time you click the send button to the time you receive a response.
*Be sure to allow extra time in the event that the server is under heavy traffic (Example: An article about Bitmessage was posted on a popular website).
*You can always send a message to another echo server. Here are two echo addresses:
** BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb
** BM-omXeTjutKWmYgQJjmoZjAG3u3NmaLEdZK
*You may subscribe to the [[Timeservice Broadcast]] to receive network heartbeats.
*You can send messages to a [[Mailing List]] in case it still does not works
If you still do not receive a response, [https://bitmessage.org/forum/index.php visit the forum] to see if there is a current technical issue or to submit a new request for assistance.

===Other===
Here is a list of average times for different parts of Bitmessage. [[PyBitmessage Help]]

Please [https://bitmessage.org/forum/index.php visit the forum] for all other issues.

TOR

2013-12-20T13:32:27Z

AyrA: completed windows instructions

{{Stub}}

TOR (''The Onion Routing'') is a network which allows users to browse the internet anonymously and securely.
This Page gives instructions on how to set up a TOR router for bitmessage.

== Windows ==
These instructions are for AdvOR, which is one of the most advanced TOR clients.

=== Obtaining a tor client ===
The client can be downloaded from sourceforge: [http://sourceforge.net/projects/advtor/ Download].

Download and extract the zip file to any location and launch the exe inside it.
The TOR client is fully portable and can be put on a USB flash drive with bitmessage.

=== Configuring the client ===
This is optional. On the top left corner of the client, click on "Proxy".
You can obtain and change the listening Port and address for your router if you wish.
In this guide the Port 9050 on address 127.0.0.1 is used.

On the left side menu, click on "System" and enable "Connect Automatically" and "Minimize at startup".
This way the client cannot easily be spotted by others and works silently.

=== Configuring Bitmessage ===
Refer to the [[FAQ#How do I setup Bitmessage to work with Tor|FAQ]].
Use the IP and port from your client, if they differ from the manual.

== Linux ==
N/A
=== Obtaining a tor client ===
N/A
=== Configuring the client ===
N/A
=== Configuring Bitmessage ===
Refer to the [[FAQ#How do I setup Bitmessage to work with Tor|FAQ]].
Use the IP and port from your client, if they differ from the manual.

== OSX ==
N/A
=== Obtaining a tor client ===
N/A
=== Configuring the client ===
N/A
=== Configuring Bitmessage ===
Refer to the [[FAQ#How do I setup Bitmessage to work with Tor|FAQ]].
Use the IP and port from your client, if they differ from the manual.

TOR

2013-12-20T11:03:32Z

AyrA: created page

Main Page

2013-12-09T06:58:20Z

AyrA: maked download links clickable

<br />
__NOTOC__
{{Infobox
|name=Bitmessage
|downloadsite=https://bitmessage.org/download/windows/Bitmessage.exe
|release caption=Current version (Beta)
|latest release date=October 10, 2013
}}
Bitmessage is a P2P communications [[Protocol specification|protocol]] used to send encrypted messages to another person or to many subscribers. It is decentralized and trustless, meaning that you need-not inherently trust any entities like root certificate authorities. It uses strong authentication which means that the sender of a message cannot be spoofed, and it aims to hide "non-content" data, like the sender and receiver of messages, from passive eavesdroppers like those running warrantless wiretapping programs. If Bitmessage is completely new to you, you may wish to start by reading the [https://bitmessage.org/bitmessage.pdf whitepaper].

=== Download ===
An open source client is available for free under the very liberal [http://opensource.org/licenses/mit-license.php MIT license]. For screenshots and a description of the client, see this CryptoJunky article: [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ "Setting Up And Using Bitmessage"].

[[File:windows_icon.png|link=https://bitmessage.org/download/windows/Bitmessage.exe]] [https://bitmessage.org/download/windows/Bitmessage.exe Download for Windows]

[[File:apple_icon.png|link=https://bitmessage.org/download/osx/Bitmessage.dmg]] [https://bitmessage.org/download/osx/Bitmessage.dmg Download for OS X]

[[File:tux.png|link=Compiling_instructions]] [[Compiling instructions|Run the source code]]

Here is a simple echo server which will send your message back to you after being received: BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb

=== Source code ===
You may view the Python [https://github.com/Bitmessage/PyBitmessage source code on Github]. Bitmessage requires PyQt and OpenSSL. Step-by-step instructions on how to run the source code on Linux, Windows, or OSX is [[Compiling instructions|available here]].

=== Security audit needed ===
Bitmessage is in need of an independent audit to verify its security. If you are a researcher capable of reviewing the source code, please [https://bitmessage.org/misc/emailaddress.png email] the lead developer. You will be helping to create a great privacy option for people everywhere!

=== Forum ===
* Visit or subscribe to the [https://pay.reddit.com/r/bitmessage Bitmessage subreddit].
* A community-based forum for questions, feedback, and discussion is also available at [https://bitmessage.org/forum Bitmessage.org/forum].

API Reference

2013-12-08T01:56:29Z

AyrA: /* List of Operations */ added auto-updating version number

=== Introduction ===

The PyBitmessage API uses [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC].

=== Enable the API ===
To enable the API, copy and paste these lines into the bitmessagesettings section of the [[keys.dat]] file (the values "username" and "password" are merely examples):
<pre>
apienabled = true
apiport = 8442
apiinterface = 127.0.0.1
apiusername = chelsea
apipassword = YourSuperPassw6rd-ChangeThIs-022w3eksssoQAWfasddswwWIU
</pre>
Additionally, you may optionally include an additional entry which will specify a program which Bitmessage will run when certain events occur.
<pre>
apinotifypath = c:\\example\\example.exe
</pre>
One of these arguments will be passed to your program: startingUp, newMessage, newBroadcast. Be sure your program doesn't crash when given newer arguments introduced in the future as this list will likely expand.

=== Remote Access ===
To access the Bitmessage API from a remote location, change the apiinterface value from '''127.0.0.1''' to '''0.0.0.0'''.

The following Python code offers a demonstration of how to create a client that can connect to the PyBitmessage API.

In this example, the username is "username", the password is "password", the IP address of the server running PyBitmessage is 105.168.1.0 (a random example), and the port number which PyBitmessage has been configured to listen on is 8442. In order to connect with the remote copy of PyBitmessage, these settings must match those in PyBitmessage's "keys.dat" file.
<pre>
import xmlrpclib
import json
import time

api = xmlrpclib.ServerProxy("http://username:password@105.168.1.0:8442/")
print api.add(2,3)
</pre>

A more complete example can be found in the [https://github.com/Bitmessage/PyBitmessage/blob/master/src/api_client.py api_client.py] file in the PyBitmessage source code.

=== List of Operations ===
Required arguments are denoted inside < and > Optional arguments are inside [ and ].
{|class="wikitable"
! Command !! Parameters !! Minimum Version !! Description
|-
| helloWorld || <firstWord> <secondWord> || 0.2.7 || returns 'firstWord-secondWord'. Used as a simple test of the API.
|-
| add || <integer> <integer> || 0.2.7 || returns the sum of the integers. Used as a simple test of the API.
|-
| statusBar || <message> || 0.2.7 || Displays the message in the status bar on the GUI
|-
| listAddresses2|| || 0.4.0 || Lists all addresses shown on the Your Identities tab. Returns a list of objects with these properties:
* label (base64, decodes into utf-8)
* address (ascii/utf-8)
* stream (integer)
* enabled (bool)
* chan (bool)

This is called listAddresses'''2''' because 'listAddresses' is obsolete.
|-
| createRandomAddress || <label> [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] || 0.2.7 || Creates one address using the random number generator. label should be base64 encoded. eighteenByteRipe is a boolean telling Bitmessage whether to generate an address with an 18 byte RIPE hash(as opposed to a 19 byte hash). This is the same setting as the "Do extra work to make the address 1 or 2 characters shorter" in the user interface. Using False is recommended if you are running some sort of website and will be generating a lot of addresses. Note that even if you don't ask for it, there is still a 1 in 256 chance that you will get an address with an 18 byte RIPE hash so if you actually ''need'' an address with a 19 byte RIPE hash for some reason, you will need to check for it. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1.

Returns the address.

Warning: At present, Bitmessage gets confused if you use both the API and the UI to make an address at the same time.
|-
|createDeterministicAddresses ||<passphrase> [numberOfAddresses] [addressVersionNumber] [streamNumber] [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] || 0.3.4 || Similar to createRandomAddress except that you may generate many addresses in one go. passphrase should be base64 encoded. numberOfAddresses defaults to 1. addressVersionNumber and streamNumber may be set to 0 which will tell Bitmessage to use the most up-to-date addressVersionNumber and the most available streamNumber. Using zero for each of these fields is recommended. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1.

Returns a list of new addresses. This list will be empty if the addresses already existed.

Warning: At present, Bitmessage gets confused if you use both the API and the UI to make addresses at the same time.
|-
|getDeterministicAddress ||<passphrase> <addressVersionNumber> <streamNumber> || 0.3.1 || Similar to createDeterministicAddresses except that the one address that is returned will not be added to the Bitmessage user interface or the keys.dat file. passphrase should be base64 encoded. addressVersionNumber should be set to 3 or 4 as these are the only ones currently supported. streamNumber must be set to 1 as this is the only one currently supported.

Returns a single address.

Warning: At present, Bitmessage gets confused if you use both this API command and the UI to make addresses at the same time.
|-
|<code>getAllInboxMessages</code>|| || 0.2.7 || Does not include trashed messages. Returns a list of objects with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* receivedTime (integer, Unix time)
* read (integer representing binary state (0 or 1))

The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it is shown in hex as that is the de facto standard. The base64 encoding Bitmessage uses includes line breaks including one on the end of the string.
|-
| getInboxMessageByID || <msgid> [read] || 0.4.0 || Returns an object with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* receivedTime (integer, Unix time)
* read (integer representing binary state (0 or 1))

Optionally sets the specific message to have a read status of 'read' (bool).

The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it should be given in hex as that is the de facto standard. The base64 encoding Bitmessage uses includes line breaks including one on the end of the string.
|-
| getSentMessageByAckData || <ackData> || 0.3.4 || Returns an object with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* lastActionTime (integer, Unix time)
* status (ascii/utf-8)
* ackData (hex)
|-
| getAllSentMessages || || 0.3.4 || Returns an object with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* lastActionTime (integer, Unix time)
* status (ascii/utf-8)
* ackData (hex)
|-
| getSentMessageByID || <msgid> || 0.3.4 || Returns an object with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* lastActionTime (integer, Unix time)
* status (ascii/utf-8)
* ackData (hex)
|-
| getSentMessagesBySender|| <fromAddress> || 0.3.4 || Returns a list of objects with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* lastActionTime (integer, Unix time)
* status (ascii/utf-8)
* ackData (hex)
|-
| trashMessage || <msgid> || 0.2.7 || returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function.
|-
| sendMessage || <toAddress> <fromAddress> <subject> <message> [encodingType] || 0.2.7 || returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility.
|-
| sendBroadcast || <fromAddress> <subject> <message> [encodingType] || 0.2.7 || returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility.
|-
| getStatus || <ackData> || 0.3.0 || returns one of these strings: <strike>notFound, findingPubkey, doingPOW, sentMessage, or ackReceived</strike> notfound, msgqueued, broadcastqueued, broadcastsent, doingpubkeypow, awaitingpubkey, doingmsgpow, forcepow, msgsent, msgsentnoackexpected, or ackreceived.
|-
| listSubscriptions|| || 0.4.0 || Returns a list of objects with these properties:
* label (base64, decodes into utf-8)
* address (ascii/utf-8)
* enabled (bool)
|-
| addSubscription|| <address> [label] || 0.3.1 || Subscribe to an address. label must be base64-encoded.
|-
| deleteSubscription|| <address> || 0.3.1 || Unsubscribe from an address. The program does not check to see whether you were subscribed in the first place.
|-
| listAddressBookEntries|| || 0.4.0 ||Returns a list of objects with these properties:
* address (ascii/utf-8)
* label (base64, decodes into utf-8)
|-
| addAddressBookEntry|| <address> <label> || 0.4.0 || Add an entry to your address book. label must be base64-encoded.
|-
| deleteAddressBookEntry|| <address> || 0.4.0 || Delete an entry from your address book. The program does not check to see whether it was there in the first place.
|-
| trashSentMessageByAckData|| <ackData> || 0.4.0 || Trashes a sent message based on its ackdata. ackData should be encoded in hex. Returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked.
|-
| createChan|| <passphrase> || 0.4.2 || Creates a new chan. passphrase must be base64 encoded. Outputs the corresponding Bitmessage address.
|-
| joinChan|| <passphrase> <address> || 0.4.2 || Join a chan. passphrase must be base64 encoded. Outputs "success"
|-
| leaveChan|| <address> || 0.4.2 || Leave a chan. Outputs "success". Note that at this time, the address is still shown in the UI until a restart.
|-
| deleteAddress|| <address> || 0.4.2 || Permanently delete an address from Your Identities and your keys.dat file. Outputs "success". Note that at this time, the address is still shown in the UI until a restart.
|-
| decodeAddress|| <address> || 0.4.2 || Returns an object with these properties:
* status (ascii/utf-8)
* addressVersion (ascii integer)
* streamNumber (ascii integer)
* ripe (base64, decodes into binary data)
|}

'''Note:''' If the minimum required version is higher than {{Bitmessage Current Version Number}} then the code is available in source but not yet available in a compiled binary.

==== Possible error values ====

Here are the various error numbers and descriptions you might see.

{|class="wikitable"
! Error Number!! Message
|-
|0000 || API Error 0000: I need parameters!
|-
| 0001 || API Error 0001: The specified passphrase is blank.
|-
| 0002 || API Error 0002: The address version number currently must be 3 or 4 (or 0 which means auto-select).
|-
| 0003 || API Error 0003: The stream number must be 1 (or 0 which means auto-select). Others aren't supported.
|-
| 0004 || API Error 0004: Why would you ask me to generate 0 addresses for you?
|-
| 0005 || API Error 0005: You have (accidentally?) specified too many addresses to make. Maximum 999. This check only exists to prevent mischief; if you really want to create more addresses than this, contact the Bitmessage developers and we can modify the check or you can do it yourself by searching the source code for this message.
|-
| 0006 || API Error 0006: The encoding type must be 2 because that is the only one this program currently supports.
|-
| 0007 || API Error 0007: Could not decode address
|-
| 0008 || API Error 0008: Checksum failed for address
|-
| 0009 || API Error 0009: Invalid characters in address
|-
| 0010 || API Error 0010: Address version number too high (or zero) in address
|-
| 0011 || API Error 0011: The address version number currently must be 2, 3, or 4. Others aren't supported.
|-
| 0012 || API Error 0012: The stream number must be 1. Others aren't supported.
|-
| 0013 || API Error 0013: Could not find your fromAddress in the keys.dat file.
|-
| 0014 || API Error 0014: Your fromAddress is disabled. Cannot send.
|-
| 0015 || API Error 0015: The length of ackData should be 32 bytes (encoded in hex thus 64 characters).
|-
| 0016 || API Error 0016: You are already subscribed to that address.
|-
| 0017 || API Error 0017: Label is not valid UTF-8 data.
|-
| 0018 || API Error 0018: Chan name does not match address.
|-
| 0019 || API Error 0019: The length of hash should be 20 bytes (encoded in hex thus 40 characters).
|-
| 0020 || API Error 0020: Invalid method: <method_name_you_tried_to_execute>
|-
| 0021 || API Error 0021: Unexpected API Failure
|-
| 0022 || API Error 0022: Decode Error
|-
| 0023 || API Error 0023: Bool expected
|-
| 0024 || API Error 0024: Chan address is already present.
|-
| 0025 || API Error 0025: Specified address is not a chan address. Use deleteAddress API call instead.
|}

Decentralized Mailing List

2013-11-29T10:37:00Z

AyrA: /* Notes */ additions for multiple address versions

A [[Mailing List]] without the requirement of a central "authority". Sometimes called Chan (short for channel) because they usually focus on a subject which also is the password for the deterministic address too.

== Issues with regular Mailing Lists ==
Despite the fact that Bitmessage is a decentralized [[p2p]] network, pseudo-mailing lists require the client who operates the list to be online, creating a [http://en.wikipedia.org/wiki/Single_point_of_failure Single Point of Failure]. Decentralized lists circumvent this issue by having a group of users share private keys. Users may optionally send messages from the decentralized mailing list identity address itself. Decentralized lists cannot be clogged up with large messages because the [[POW]] is only done by the sending client.

== Creation ==
A DML can be created in the File menu with the Option "Join / Create chan". A Passphrase must be entered and the address is generated.

== Joining ==
A DML can be joined in the File menu with the Option "Join / Create chan". A Passphrase and the address must be entered.

== Notes ==
There is no technical difference between creation and joining a DML. Joining requires the address to make sure that you typed the DML name correctly and to make sure that you are using the correct stream number and address version which are included in the address.

== Incompatibilities ==
* You cannot use the n-th address or generate short addresses with the create/join dialog. You can do so when generating a deterministic address but it will not be recognized as DML.
* You cannot send messages to a DML if you are not member. This is caused by the fact, that a DML address does not publishes its public key.

== Circumvent stuck client ==
To circumvent non-members of getting stuck, a user can create a deterministic address with the same configuration as the DML Address (provided he hasn't the DML already in his identities), this address will answer key requests and non-members world wide can use the DML.

== Usage ==
To properly use a DML, a user can
* Write from the DML, to the DML: This is completely anonymous and is the default behaviour that should be taken.
* Write from a personal address to the DML: This can be used so answers given to the message will only be sent to the private address and not to the DML, or it can be used to "sign" messages with the private adress so nobody can claim it was he, who sent it.

== Issues with Decentralized Mailing Lists ==
* Since all users share the same address it cannot be easily verified, who sent a message.
* Spam cannot be blocked on address base, since everyone shares the same sender address.
* Non-Members cannot write to a DML

== Updating ==
If a user was a member of a DML before 0.3.5 came out, he might want to update the address to a DML.
To do so, first of all the subscription needs to be removed in the GUI, after that, the [[keys.dat]] needs to be edited and the line "chan = true" needs to be inserted into the address block that should be a DML.

== Example Address ==
Passphrase: '''general''', Address: '''BM-2DAV89w336ovy6BUJnfVRD5B9qipFbRgmr'''.
The [[Address Block]] of a DML should look like this (it may have additional entries):

<pre>
[BM-2DAV89w336ovy6BUJnfVRD5B9qipFbRgmr]
label = general
enabled = true
decoy = false
chan = true
privsigningkey = 5Jnbdwc4u4DG9ipJxYLznXSvemkRFueQJNHujAQamtDDoX3N1eQ
privencryptionkey = 5JrDcFtQDv5ydcHRW6dfGUEvThoxCCLNEUaxQfy8LXXgTJzVAcq
</pre>

== Address List ==
A list of addresses can be found at [https://bitmessage.org/forum/index.php/topic,1420.0.html the forum].

[[Category:Address terms]]

FAQ

2013-10-28T06:36:32Z

AyrA: /* How does Bitmessage compare to other messaging methods */ GPG Mail has attachments too

==Installation and configuration==
===How do I install Bitmessage===
Bitmessage does not needs to be "installed". it is simply downloaded and executed. You can find instructions to download and run bitmessage from the [[Main Page]].
A great write up for setting up and using Bitmessage on Windows can be found [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ Here.]

Bitmessage should run on any OS though it is only lightly tested on OSX. The start-on-boot and minimize-to-tray features are only implemented for Windows thus far. Several examples of how to install Bitmessage on *nix and OSX platforms can be found [https://bitmessage.org/forum/index.php in the forums.]

===How do I become a node to help the network===
If your connection indicator is green then you are already accepting incoming connections and helping the Bitmessage network.

If your connection indicator is yellow, check your firewall settings and port forwarding to make sure incoming connections are allowed to your machine on the correct TCP port (Default: 8444), the port can be found in the Bitmessage settings.

You can click on the indicator for more information about each color.

===Why is my Connection Indicator Yellow===
Bitmessage will work normally with a yellow indicator. If your indicator is yellow, you can have up to 8 connections. To make your indicator green, please forward the required TCP port (usually 8444). You can find the Port in the Bitmessage settings.

===How do I setup Bitmessage to work with Tor===

'''Tor'''

If you are using the Tor Browser Bundle skip to the next section. In order for Bitmessage to use Tor as a proxy follow these steps.
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9050'.
*Select ok.
*Restart Bitmessage.

'''Tor Browser Bundle'''
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9150'.
*Select ok.
*Restart Bitmessage.

==Usage==
===How can I run Bitmessage in daemon mode===
Refer to the [[Daemon|Daemon Mode Page]].

===How many connections should I have===
As long as you have at least one connection, you can communicate with the network. If your connection indicator is yellow, you can have a maximum of 8 connections.

===Can I send a message to someone that is offline===
Yes. However, if you go offline then they must come back online within 2 days of the message being sent. Nodes delete data, and do not accept data, older than 2 days.

===How do I format my messages===
Here is [https://qt-project.org/doc/qt-4.8/richtext-html-subset.html the list of supported HTML tags].

===What are subscriptions?===

A [[Subscriptions|subscription]] allows you to receive messages, that were broadcasted by the address you subscribe too.
Since [[broadcast]] messages are encrypted with a key, that can be created by everyone who knows the address, you must be subscribed to an address to actually read the messages.

Subscriptions are also required to use a [[Mailing List]].

===What are "chans"?===
Chan is another word for DML. Please refer to [[DML|this article]] for a complete documentation of this rather complex feature.

==How does Bitmessage work==
'''Startup'''

When you first start Bitmessage, your client connects itself to the network and starts downloading a list of known nodes. Each new node that you connect to shares its list of known nodes. In addition to the known nodes, you will also start receiving person-to-person messages, broadcasts, and public keys. If any of these messages are bound for you, they will be shown in your inbox. All of this data is exchanged between all of your connections to make sure that everyone has a copy.

'''Sending a Message'''

When you send a message, your client must first compute a Proof of Work (POW). This POW helps mitigate spam on the network. Nodes and other clients will not process your message if it does not show sufficient POW. After the POW is complete, your message is shared to all of your connections which in turn share it with all of their connections.

===Where can I find more documentation about Bitmessage===
* [https://bitmessage.org/bitmessage.pdf Overview White Paper (PDF)]
* [[Protocol specification]]
* Detail about the [[Proof of work]]

==How does Bitmessage compare to other messaging methods==
Here is a table comparing Bitmessage to other common messaging services.

{| border="1" class="wikitable"
|+ Comparison of Messaging Services
!  
! Trustless
! P2P
! Open Source
! Requires Proof of Work
! Hide Sender?
! Hide Receiver?
! Mobile Version
! Application or Web Based
! Text Only Messages
! Attachments
! Acknowledge delivery
|-
! Bitmessage
| {{Yes}}
| {{Yes}}
| [http://opensource.org/licenses/mit-license.php MIT]
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{No}}
| {{Yes|180 MB}}
| {{Yes}}
|-
! Standard Email
|
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{No}}
| {{Yes}}
| {{Partial}}
|-
! Email + GPG
| {{Yes}}
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{Yes}}
| {{Partial}}
|-
! [http://xmpp.org/ XMPP] + [https://en.wikipedia.org/wiki/Off-the-Record_Messaging OTR]
| {{Yes}}
| {{No}}
| {{Yes|GPL V2.1}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [http://www.skype.com/en/ Skype]
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [http://www.scayl.com/ Scayl]
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes|Alpha}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/I2P#E-mail I2P Bote]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL V3}}
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
! [https://crypto.cat/ CryptoCat]
| {{No}}
| {{No}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC]
|
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! SMS
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [http://retroshare.sourceforge.net/ RetroShare]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
|
|
|
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/Freenet#Tools_and_applications Freenet + Frost]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + FMS]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + Freemail] 0.2
| {{No}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [https://wiki.freenetproject.org/FLIP Freenet + FLIP]
| {{Yes}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
|
| {{Yes}}
|
| {{No}}
| {{Partial|Via Tor}}
| {{Partial|Via Tor}}
|
| Application
|
| {{Yes}}
|
|}

==Troubleshooting==
===My Connection Indicator is Red===
Check your connection settings.
Check if you can access the internet. In case you have a firewall with outgoing restrictions (not Windoes firewall) allow unrestricted access for Bitmessage through your firewall.
Sometimes Bitmessage takes time to connect to the network, especially if [[knownnodes.dat]] is large. Please allow at least 30 minutes for it to connect before posting to the forum.
You can also try deleting [[knownnodes.dat]].

If none of that works, [https://bitmessage.org/forum/index.php please visit the forum here.]

===I have not received a reply from the Echo Server===
*Your connection indicator should be yellow or green.
*Make sure that your POW is complete and the message has been sent. You should see an acknowledgement under "Status" on the "Sent" tab.
*On average it should take 8 minutes from the time you click the send button to the time you receive a response.
*Be sure to allow extra time in the event that the server is under heavy traffic (Example: An article about Bitmessage was posted on a popular website).
*You can always send a message to another echo server. Here are two echo addresses:
** BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb
** BM-omXeTjutKWmYgQJjmoZjAG3u3NmaLEdZK
*You may subscribe to the [[Timeservice Broadcast]] to receive network heartbeats.
*You can send messages to a [[Mailing List]] in case it still does not works
If you still do not receive a response, [https://bitmessage.org/forum/index.php visit the forum] to see if there is a current technical issue or to submit a new request for assistance.

===Other===
Here is a list of average times for different parts of Bitmessage. [[PyBitmessage Help]]

Please [https://bitmessage.org/forum/index.php visit the forum] for all other issues.

User:AyrA

2013-10-24T21:02:08Z

AyrA: added bitmsg ref

== About me ==
I am a bitmessage user since early april 2013 and I am providing multiple free services to bitmessage users worldwide, including bitmessage.ch E-Mail gateway and the timeservice broadcast, the probably oldest broadcasting service still active.

I administer this wiki and keep it clean from spam.

== Services/Tools ==

You can find an updated list of all services and tools I provide on [http://bitm.sg bitm.sg]

=== [[Timeservice Broadcast|TIMESERVICE]] ===
Address: '''BM-BcbRqcFFSQUUmXFKsPJgVQPSiFA3Xash'''

You may subscribe to this address and receive time messages. The service broadcasts the current UTC time every 10 minutes, causing to be a network hartbeat.

=== 24x7 List ===
Address: '''BM-GuRLKDhQA5hAhE6PDQpkcvbtt1AuXAdQ'''

A Mailing list that is up 24x7. Has no specific subject.

=== bitmessage.ch ===
Location: [https://bitmessage.ch bitmessage.ch]

Allows users to use bitmessage without a bitmessage client. It converts bitmessages to E-Mail and vice versa. It can be accessed via the webmail or any E-Mail client. Has TOR and HTTPS support

=== BitText ===
Location: [http://bittext.ch BitText.ch] or [https://bitmessage.org/forum/index.php/topic,3237.0.html Official Forum]

Address: '''BM-GtkZoid3xpTUnwxezDfpWtYAfY6vgyHd'''

A Pastebin alternative via Bitmessage.

=== Bitmessage2Mail ===
Location: [https://bitmessage.org/forum/index.php/topic,1587.0.html Official Forum]

The same as bitmessage.ch but all packed in a local Windows application, not requiring to use a third party service. Contains advanced options to make messages readable for bitmessage users.
The forum page contains all required informations to set it up.

=== BitCrypter ===
Location: [https://bitmessage.org/forum/index.php/topic,1589.0.html Official Forum]

Allows encryption of the [[keys.dat]] file, preventing it from being stolen.

=== BitSign ===
Location: [https://bitmessage.org/forum/index.php/topic,2827.0.html Official Forum] [http://home.ayra.ch/bitsign BitSign download page]

Allows users to download signed versions of bitmessage to prevent it from being modified in mid-transmission. The signed version is updated once per hour. Additionally, serves as mirror for the client

=== BitDNS ===
Location: [https://bitmessage.org/forum/index.php/topic,3281.0.html Official Forum]

Provides DNS inclusion for bitmessage addresses

Example pyinstaller spec file

2013-10-24T06:02:24Z

AyrA: this is a stub

{{Stub}}
<pre>
# -*- mode: python -*-
a = Analysis(['src\\bitmessagemain.py'],
pathex=['C:\\example\\pyinstaller'],
hiddenimports=[],
hookspath=None)

def addTranslations():
import os
extraDatas = []
for file in os.listdir('src\\translations'):
extraDatas.append(('translations\\'+file, 'src\\translations\\' + file, 'DATA'))
return extraDatas

# append the translations directory
a.datas += addTranslations()

pyz = PYZ(a.pure)
exe = EXE(pyz,
a.scripts,
a.binaries,
a.zipfiles,
a.datas,
a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],
name=os.path.join('dist', 'bitmessagemain.exe'),
debug=False,
strip=None,
upx=True,
console=False , icon='src\\images\\can-icon.ico')
app = BUNDLE(exe,
name=os.path.join('dist', 'bitmessagemain.exe.app'))

</pre>

User:AyrA

2013-10-22T09:51:43Z

AyrA: /* Services/Tools */ BitDNS

== About me ==
I am a bitmessage user since early april 2013 and I am providing multiple free services to bitmessage users worldwide, including bitmessage.ch E-Mail gateway and the timeservice broadcast, the probably oldest broadcasting service still active.

I administer this wiki and keep it clean from spam.

== Services/Tools ==

=== [[Timeservice Broadcast|TIMESERVICE]] ===
Address: '''BM-BcbRqcFFSQUUmXFKsPJgVQPSiFA3Xash'''

You may subscribe to this address and receive time messages. The service broadcasts the current UTC time every 10 minutes, causing to be a network hartbeat.

=== 24x7 List ===
Address: '''BM-GuRLKDhQA5hAhE6PDQpkcvbtt1AuXAdQ'''

A Mailing list that is up 24x7. Has no specific subject.

=== bitmessage.ch ===
Location: [https://bitmessage.ch bitmessage.ch]

Allows users to use bitmessage without a bitmessage client. It converts bitmessages to E-Mail and vice versa. It can be accessed via the webmail or any E-Mail client. Has TOR and HTTPS support

=== BitText ===
Location: [http://bittext.ch BitText.ch] or [https://bitmessage.org/forum/index.php/topic,3237.0.html Official Forum]

Address: '''BM-GtkZoid3xpTUnwxezDfpWtYAfY6vgyHd'''

A Pastebin alternative via Bitmessage.

=== Bitmessage2Mail ===
Location: [https://bitmessage.org/forum/index.php/topic,1587.0.html Official Forum]

The same as bitmessage.ch but all packed in a local Windows application, not requiring to use a third party service. Contains advanced options to make messages readable for bitmessage users.
The forum page contains all required informations to set it up.

=== BitCrypter ===
Location: [https://bitmessage.org/forum/index.php/topic,1589.0.html Official Forum]

Allows encryption of the [[keys.dat]] file, preventing it from being stolen.

=== BitSign ===
Location: [https://bitmessage.org/forum/index.php/topic,2827.0.html Official Forum] [http://home.ayra.ch/bitsign BitSign download page]

Allows users to download signed versions of bitmessage to prevent it from being modified in mid-transmission. The signed version is updated once per hour. Additionally, serves as mirror for the client

=== BitDNS ===
Location: [https://bitmessage.org/forum/index.php/topic,3281.0.html Official Forum]

Provides DNS inclusion for bitmessage addresses

API Reference

2013-10-14T19:27:11Z

AyrA: /* Possible error values */ replaced asdfasdf

=== Introduction ===

The PyBitmessage API uses [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC].

=== Enable the API ===
To enable the API, copy and paste these lines into the bitmessagesettings section of the [[keys.dat]] file (the values "username" and "password" are merely examples):
<pre>
apienabled = true
apiport = 8442
apiinterface = 127.0.0.1
apiusername = chelsea
apipassword = YourSuperPassw6rd-ChangeThIs-022w3eksssoQAWfasddswwWIU
</pre>
Additionally, you may optionally include an additional entry which will specify a program which Bitmessage will run when certain events occur.
<pre>
apinotifypath = c:\\example\\example.exe
</pre>
One of these arguments will be passed to your program: startingUp, newMessage, newBroadcast. Be sure your program doesn't crash when given newer arguments introduced in the future as this list will likely expand.

=== Remote Access ===
To access the Bitmessage API from a remote location, change the apiinterface value from '''127.0.0.1''' to '''0.0.0.0'''.

The following Python code offers a demonstration of how to create a client that can connect to the PyBitmessage API.

In this example, the username is "username", the password is "password", the IP address of the server running PyBitmessage is 105.168.1.0 (a random example), and the port number which PyBitmessage has been configured to listen on is 8442. In order to connect with the remote copy of PyBitmessage, these settings must match those in PyBitmessage's "keys.dat" file.
<pre>
import xmlrpclib
import json
import time

api = xmlrpclib.ServerProxy("http://username:password@105.168.1.0:8442/")
print api.add(2,3)
</pre>

A more complete example can be found in the [https://github.com/Bitmessage/PyBitmessage/blob/master/src/api_client.py api_client.py] file in the PyBitmessage source code.

=== List of Operations ===
Required arguments are denoted inside < and > Optional arguments are inside [ and ].
{|class="wikitable"
! Command !! Parameters !! Minimum Version !! Description
|-
| helloWorld || <firstWord> <secondWord> || 0.2.7 || returns 'firstWord-secondWord'. Used as a simple test of the API.
|-
| add || <integer> <integer> || 0.2.7 || returns the sum of the integers. Used as a simple test of the API.
|-
| statusBar || <message> || 0.2.7 || Displays the message in the status bar on the GUI
|-
| listAddresses2|| || 0.4.0 || Lists all addresses shown on the Your Identities tab. Returns a list of objects with these properties:
* label (base64, decodes into utf-8)
* address (ascii/utf-8)
* stream (integer)
* enabled (bool)

This is called listAddresses'''2''' because 'listAddresses' is obsolete.
|-
| createRandomAddress || <label> [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] || 0.2.7 || Creates one address using the random number generator. label should be base64 encoded. eighteenByteRipe is a boolean telling Bitmessage whether to generate an address with an 18 byte RIPE hash(as opposed to a 19 byte hash). This is the same setting as the "Do extra work to make the address 1 or 2 characters shorter" in the user interface. Using False is recommended if you are running some sort of website and will be generating a lot of addresses. Note that even if you don't ask for it, there is still a 1 in 256 chance that you will get an address with an 18 byte RIPE hash so if you actually ''need'' an address with a 19 byte RIPE hash for some reason, you will need to check for it. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1.

Returns the address.

Warning: At present, Bitmessage gets confused if you use both the API and the UI to make an address at the same time.
|-
|createDeterministicAddresses ||<passphrase> [numberOfAddresses] [addressVersionNumber] [streamNumber] [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] || 0.3.4 || Similar to createRandomAddress except that you may generate many addresses in one go. passphrase should be base64 encoded. numberOfAddresses defaults to 1. addressVersionNumber and streamNumber may be set to 0 which will tell Bitmessage to use the most up-to-date addressVersionNumber and the most available streamNumber. Using zero for each of these fields is recommended. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1.

Returns a list of new addresses. This list will be empty if the addresses already existed.

Warning: At present, Bitmessage gets confused if you use both the API and the UI to make addresses at the same time.
|-
|getDeterministicAddress ||<passphrase> <addressVersionNumber> <streamNumber> || 0.3.1 || Similar to createDeterministicAddresses except that the one address that is returned will not be added to the Bitmessage user interface or the keys.dat file. passphrase should be base64 encoded. addressVersionNumber should be set to 3 or 4 as these are the only ones currently supported. streamNumber must be set to 1 as this is the only one currently supported.

Returns a single address.

Warning: At present, Bitmessage gets confused if you use both this API command and the UI to make addresses at the same time.
|-
|<code>getAllInboxMessages</code>|| || 0.2.7 || Does not include trashed messages. Returns a list of objects with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* receivedTime (integer, Unix time)
* read (integer representing binary state (0 or 1))

The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it is shown in hex as that is the de facto standard. The base64 encoding Bitmessage uses includes line breaks including one on the end of the string.
|-
| getInboxMessageByID || <msgid> [read] || 0.4.0 || Returns an object with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* receivedTime (integer, Unix time)
* read (integer representing binary state (0 or 1))

Optionally sets the specific message to have a read status of 'read' (bool).

The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it should be given in hex as that is the de facto standard. The base64 encoding Bitmessage uses includes line breaks including one on the end of the string.
|-
| getSentMessageByAckData || <ackData> || 0.3.4 || Returns an object with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* lastActionTime (integer, Unix time)
* status (ascii/utf-8)
* ackData (hex)
|-
| getAllSentMessages || || 0.3.4 || Returns an object with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* lastActionTime (integer, Unix time)
* status (ascii/utf-8)
* ackData (hex)
|-
| getSentMessageByID || <msgid> || 0.3.4 || Returns an object with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* lastActionTime (integer, Unix time)
* status (ascii/utf-8)
* ackData (hex)
|-
| getSentMessagesBySender|| <fromAddress> || 0.3.4 || Returns a list of objects with these properties:
* msgid (hex)
* toAddress (ascii/utf-8)
* fromAddress (ascii/utf-8)
* subject (base64, decodes into utf-8)
* message (base64, decodes into utf-8)
* [[Protocol_specification#Message_Encodings|encodingType]] (integer)
* lastActionTime (integer, Unix time)
* status (ascii/utf-8)
* ackData (hex)
|-
| trashMessage || <msgid> || 0.2.7 || returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function.
|-
| sendMessage || <toAddress> <fromAddress> <subject> <message> [encodingType] || 0.2.7 || returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility.
|-
| sendBroadcast || <fromAddress> <subject> <message> [encodingType] || 0.2.7 || returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility.
|-
| getStatus || <ackData> || 0.3.0 || returns one of these strings: <strike>notFound, findingPubkey, doingPOW, sentMessage, or ackReceived</strike> notfound, msgqueued, broadcastqueued, broadcastsent, doingpubkeypow, awaitingpubkey, doingmsgpow, forcepow, msgsent, msgsentnoackexpected, or ackreceived.
|-
| listSubscriptions|| || 0.4.0 || Returns a list of objects with these properties:
* label (base64, decodes into utf-8)
* address (ascii/utf-8)
* enabled (bool)
|-
| addSubscription|| <address> [label] || 0.3.1 || Subscribe to an address. label must be base64-encoded.
|-
| deleteSubscription|| <address> || 0.3.1 || Unsubscribe from an address. The program does not check to see whether you were subscribed in the first place.
|-
| listAddressBookEntries|| || 0.4.0 ||Returns a list of objects with these properties:
* address (ascii/utf-8)
* label (base64, decodes into utf-8)
|-
| addAddressBookEntry|| <address> <label> || 0.4.0 || Add an entry to your address book. label must be base64-encoded.
|-
| deleteAddressBookEntry|| <address> || 0.4.0 || Delete an entry from your address book. The program does not check to see whether it was there in the first place.
|-
| trashSentMessageByAckData|| <ackData> || 0.4.0 || Trashes a sent message based on its ackdata. ackData should be encoded in hex. Returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked.
|}

'''Note:''' Version "source" indicates, that the function is only available in the source version of PyBitmessage and has not yet been included in a precompiled binary.

==== Possible error values ====

Here are the various error numbers and descriptions you might see.

{|class="wikitable"
! Error Number!! Message
|-
|0000 || API Error 0000: I need parameters!
|-
| 0001 || API Error 0001: The specified passphrase is blank.
|-
| 0002 || API Error 0002: The address version number currently must be 3 or 4 (or 0 which means auto-select).
|-
| 0003 || API Error 0003: The stream number must be 1 (or 0 which means auto-select). Others aren't supported.
|-
| 0004 || API Error 0004: Why would you ask me to generate 0 addresses for you?
|-
| 0005 || API Error 0005: You have (accidentally?) specified too many addresses to make. Maximum 999. This check only exists to prevent mischief; if you really want to create more addresses than this, contact the Bitmessage developers and we can modify the check or you can do it yourself by searching the source code for this message.
|-
| 0006 || API Error 0006: The encoding type must be 2 because that is the only one this program currently supports.
|-
| 0007 || API Error 0007: Could not decode address
|-
| 0008 || API Error 0008: Checksum failed for address
|-
| 0009 || API Error 0009: Invalid characters in address
|-
| 0010 || API Error 0010: Address version number too high (or zero) in address
|-
| 0011 || API Error 0011: The address version number currently must be 2, 3, or 4. Others aren't supported.
|-
| 0012 || API Error 0012: The stream number must be 1. Others aren't supported.
|-
| 0013 || API Error 0013: Could not find your fromAddress in the keys.dat file.
|-
| 0014 || API Error 0014: Your fromAddress is disabled. Cannot send.
|-
| 0015 || API Error 0015: The length of ackData should be 32 bytes (encoded in hex thus 64 characters).
|-
| 0016 || API Error 0016: You are already subscribed to that address.
|-
| 0017 || API Error 0017: Label is not valid UTF-8 data.
|-
| 0018 || API Error 0018: Chan name does not match address.
|-
| 0019 || API Error 0019: The length of hash should be 20 bytes (encoded in hex thus 40 characters).
|-
| 0020 || API Error 0020: Invalid method: <method_name_you_tried_to_execute>
|-
| 0021 || API Error 0021: Unexpected API Failure
|-
| 0022 || API Error 0022: Decode Error
|-
| 0023 || API Error 0023: Bool expected
|}

FAQ

2013-10-12T12:11:44Z

AyrA: /* How does Bitmessage compare to other messaging methods */ attachemnts...

==Installation and configuration==
===How do I install Bitmessage===
Bitmessage does not needs to be "installed". it is simply downloaded and executed. You can find instructions to download and run bitmessage from the [[Main Page]].
A great write up for setting up and using Bitmessage on Windows can be found [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ Here.]

Bitmessage should run on any OS though it is only lightly tested on OSX. The start-on-boot and minimize-to-tray features are only implemented for Windows thus far. Several examples of how to install Bitmessage on *nix and OSX platforms can be found [https://bitmessage.org/forum/index.php in the forums.]

===How do I become a node to help the network===
If your connection indicator is green then you are already accepting incoming connections and helping the Bitmessage network.

If your connection indicator is yellow, check your firewall settings and port forwarding to make sure incoming connections are allowed to your machine on the correct TCP port (Default: 8444), the port can be found in the Bitmessage settings.

You can click on the indicator for more information about each color.

===Why is my Connection Indicator Yellow===
Bitmessage will work normally with a yellow indicator. If your indicator is yellow, you can have up to 8 connections. To make your indicator green, please forward the required TCP port (usually 8444). You can find the Port in the Bitmessage settings.

===How do I setup Bitmessage to work with Tor===

'''Tor'''

If you are using the Tor Browser Bundle skip to the next section. In order for Bitmessage to use Tor as a proxy follow these steps.
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9050'.
*Select ok.
*Restart Bitmessage.

'''Tor Browser Bundle'''
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9150'.
*Select ok.
*Restart Bitmessage.

==Usage==
===How can I run Bitmessage in daemon mode===
Refer to the [[Daemon|Daemon Mode Page]].

===How many connections should I have===
As long as you have at least one connection, you can communicate with the network. If your connection indicator is yellow, you can have a maximum of 8 connections.

===Can I send a message to someone that is offline===
Yes. However, if you go offline then they must come back online within 2 days of the message being sent. Nodes delete data, and do not accept data, older than 2 days.

===How do I format my messages===
Here is [https://qt-project.org/doc/qt-4.8/richtext-html-subset.html the list of supported HTML tags].

===What are subscriptions?===

A [[Subscriptions|subscription]] allows you to receive messages, that were broadcasted by the address you subscribe too.
Since [[broadcast]] messages are encrypted with a key, that can be created by everyone who knows the address, you must be subscribed to an address to actually read the messages.

Subscriptions are also required to use a [[Mailing List]].

===What are "chans"?===
Chan is another word for DML. Please refer to [[DML|this article]] for a complete documentation of this rather complex feature.

==How does Bitmessage work==
'''Startup'''

When you first start Bitmessage, your client connects itself to the network and starts downloading a list of known nodes. Each new node that you connect to shares its list of known nodes. In addition to the known nodes, you will also start receiving person-to-person messages, broadcasts, and public keys. If any of these messages are bound for you, they will be shown in your inbox. All of this data is exchanged between all of your connections to make sure that everyone has a copy.

'''Sending a Message'''

When you send a message, your client must first compute a Proof of Work (POW). This POW helps mitigate spam on the network. Nodes and other clients will not process your message if it does not show sufficient POW. After the POW is complete, your message is shared to all of your connections which in turn share it with all of their connections.

===Where can I find more documentation about Bitmessage===
* [https://bitmessage.org/bitmessage.pdf Overview White Paper (PDF)]
* [[Protocol specification]]
* Detail about the [[Proof of work]]

==How does Bitmessage compare to other messaging methods==
Here is a table comparing Bitmessage to other common messaging services.

{| border="1" class="wikitable"
|+ Comparison of Messaging Services
!  
! Trustless
! P2P
! Open Source
! Requires Proof of Work
! Hide Sender?
! Hide Receiver?
! Mobile Version
! Application or Web Based
! Text Only Messages
! Attachments
! Acknowledge delivery
|-
! Bitmessage
| {{Yes}}
| {{Yes}}
| [http://opensource.org/licenses/mit-license.php MIT]
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{No}}
| {{Yes|180 MB}}
| {{Yes}}
|-
! Standard Email
|
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{No}}
| {{Yes}}
| {{Partial}}
|-
! Email + GPG
| {{Yes}}
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
| {{Partial}}
|-
! [http://xmpp.org/ XMPP] + [https://en.wikipedia.org/wiki/Off-the-Record_Messaging OTR]
| {{Yes}}
| {{No}}
| {{Yes|GPL V2.1}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [http://www.skype.com/en/ Skype]
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [http://www.scayl.com/ Scayl]
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes|Alpha}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/I2P#E-mail I2P Bote]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL V3}}
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
! [https://crypto.cat/ CryptoCat]
| {{No}}
| {{No}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC]
|
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! SMS
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [http://retroshare.sourceforge.net/ RetroShare]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
|
|
|
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/Freenet#Tools_and_applications Freenet + Frost]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + FMS]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + Freemail] 0.2
| {{No}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [https://wiki.freenetproject.org/FLIP Freenet + FLIP]
| {{Yes}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
|
| {{Yes}}
|
| {{No}}
| {{Partial|Via Tor}}
| {{Partial|Via Tor}}
|
| Application
|
| {{Yes}}
|
|}

==Troubleshooting==
===My Connection Indicator is Red===
Check your connection settings.
Check if you can access the internet. In case you have a firewall with outgoing restrictions (not Windoes firewall) allow unrestricted access for Bitmessage through your firewall.
Sometimes Bitmessage takes time to connect to the network, especially if [[knownnodes.dat]] is large. Please allow at least 30 minutes for it to connect before posting to the forum.
You can also try deleting [[knownnodes.dat]].

If none of that works, [https://bitmessage.org/forum/index.php please visit the forum here.]

===I have not received a reply from the Echo Server===
*Your connection indicator should be yellow or green.
*Make sure that your POW is complete and the message has been sent. You should see an acknowledgement under "Status" on the "Sent" tab.
*On average it should take 8 minutes from the time you click the send button to the time you receive a response.
*Be sure to allow extra time in the event that the server is under heavy traffic (Example: An article about Bitmessage was posted on a popular website).
*You can always send a message to another echo server. Here are two echo addresses:
** BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb
** BM-omXeTjutKWmYgQJjmoZjAG3u3NmaLEdZK
*You may subscribe to the [[Timeservice Broadcast]] to receive network heartbeats.
*You can send messages to a [[Mailing List]] in case it still does not works
If you still do not receive a response, [https://bitmessage.org/forum/index.php visit the forum] to see if there is a current technical issue or to submit a new request for assistance.

===Other===
Here is a list of average times for different parts of Bitmessage. [[PyBitmessage Help]]

Please [https://bitmessage.org/forum/index.php visit the forum] for all other issues.

FAQ

2013-10-12T12:07:17Z

AyrA: /* How does Bitmessage compare to other messaging methods */ more colors

==Installation and configuration==
===How do I install Bitmessage===
Bitmessage does not needs to be "installed". it is simply downloaded and executed. You can find instructions to download and run bitmessage from the [[Main Page]].
A great write up for setting up and using Bitmessage on Windows can be found [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ Here.]

Bitmessage should run on any OS though it is only lightly tested on OSX. The start-on-boot and minimize-to-tray features are only implemented for Windows thus far. Several examples of how to install Bitmessage on *nix and OSX platforms can be found [https://bitmessage.org/forum/index.php in the forums.]

===How do I become a node to help the network===
If your connection indicator is green then you are already accepting incoming connections and helping the Bitmessage network.

If your connection indicator is yellow, check your firewall settings and port forwarding to make sure incoming connections are allowed to your machine on the correct TCP port (Default: 8444), the port can be found in the Bitmessage settings.

You can click on the indicator for more information about each color.

===Why is my Connection Indicator Yellow===
Bitmessage will work normally with a yellow indicator. If your indicator is yellow, you can have up to 8 connections. To make your indicator green, please forward the required TCP port (usually 8444). You can find the Port in the Bitmessage settings.

===How do I setup Bitmessage to work with Tor===

'''Tor'''

If you are using the Tor Browser Bundle skip to the next section. In order for Bitmessage to use Tor as a proxy follow these steps.
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9050'.
*Select ok.
*Restart Bitmessage.

'''Tor Browser Bundle'''
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9150'.
*Select ok.
*Restart Bitmessage.

==Usage==
===How can I run Bitmessage in daemon mode===
Refer to the [[Daemon|Daemon Mode Page]].

===How many connections should I have===
As long as you have at least one connection, you can communicate with the network. If your connection indicator is yellow, you can have a maximum of 8 connections.

===Can I send a message to someone that is offline===
Yes. However, if you go offline then they must come back online within 2 days of the message being sent. Nodes delete data, and do not accept data, older than 2 days.

===How do I format my messages===
Here is [https://qt-project.org/doc/qt-4.8/richtext-html-subset.html the list of supported HTML tags].

===What are subscriptions?===

A [[Subscriptions|subscription]] allows you to receive messages, that were broadcasted by the address you subscribe too.
Since [[broadcast]] messages are encrypted with a key, that can be created by everyone who knows the address, you must be subscribed to an address to actually read the messages.

Subscriptions are also required to use a [[Mailing List]].

===What are "chans"?===
Chan is another word for DML. Please refer to [[DML|this article]] for a complete documentation of this rather complex feature.

==How does Bitmessage work==
'''Startup'''

When you first start Bitmessage, your client connects itself to the network and starts downloading a list of known nodes. Each new node that you connect to shares its list of known nodes. In addition to the known nodes, you will also start receiving person-to-person messages, broadcasts, and public keys. If any of these messages are bound for you, they will be shown in your inbox. All of this data is exchanged between all of your connections to make sure that everyone has a copy.

'''Sending a Message'''

When you send a message, your client must first compute a Proof of Work (POW). This POW helps mitigate spam on the network. Nodes and other clients will not process your message if it does not show sufficient POW. After the POW is complete, your message is shared to all of your connections which in turn share it with all of their connections.

===Where can I find more documentation about Bitmessage===
* [https://bitmessage.org/bitmessage.pdf Overview White Paper (PDF)]
* [[Protocol specification]]
* Detail about the [[Proof of work]]

==How does Bitmessage compare to other messaging methods==
Here is a table comparing Bitmessage to other common messaging services.

{| border="1" class="wikitable"
|+ Comparison of Messaging Services
!  
! Trustless
! P2P
! Open Source
! Requires Proof of Work
! Hide Sender?
! Hide Receiver?
! Mobile Version
! Application or Web Based
! Text Only Messages
! Attachments
! Acknowledge delivery
|-
! Bitmessage
| {{Yes}}
| {{Yes}}
| [http://opensource.org/licenses/mit-license.php MIT]
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{No}}
| {{Partial|Small only}}
| {{Yes}}
|-
! Standard Email
|
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{No}}
| {{Yes}}
| {{Partial}}
|-
! Email + GPG
| {{Yes}}
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
| {{Partial}}
|-
! [http://xmpp.org/ XMPP] + [https://en.wikipedia.org/wiki/Off-the-Record_Messaging OTR]
| {{Yes}}
| {{No}}
| {{Yes|GPL V2.1}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [http://www.skype.com/en/ Skype]
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [http://www.scayl.com/ Scayl]
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes|Alpha}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/I2P#E-mail I2P Bote]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL V3}}
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
! [https://crypto.cat/ CryptoCat]
| {{No}}
| {{No}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC]
|
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! SMS
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [http://retroshare.sourceforge.net/ RetroShare]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
|
|
|
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/Freenet#Tools_and_applications Freenet + Frost]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + FMS]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + Freemail] 0.2
| {{No}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [https://wiki.freenetproject.org/FLIP Freenet + FLIP]
| {{Yes}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
|
| {{Yes}}
|
| {{No}}
| {{Partial|Via Tor}}
| {{Partial|Via Tor}}
|
| Application
|
| {{Yes}}
|
|}

==Troubleshooting==
===My Connection Indicator is Red===
Check your connection settings.
Check if you can access the internet. In case you have a firewall with outgoing restrictions (not Windoes firewall) allow unrestricted access for Bitmessage through your firewall.
Sometimes Bitmessage takes time to connect to the network, especially if [[knownnodes.dat]] is large. Please allow at least 30 minutes for it to connect before posting to the forum.
You can also try deleting [[knownnodes.dat]].

If none of that works, [https://bitmessage.org/forum/index.php please visit the forum here.]

===I have not received a reply from the Echo Server===
*Your connection indicator should be yellow or green.
*Make sure that your POW is complete and the message has been sent. You should see an acknowledgement under "Status" on the "Sent" tab.
*On average it should take 8 minutes from the time you click the send button to the time you receive a response.
*Be sure to allow extra time in the event that the server is under heavy traffic (Example: An article about Bitmessage was posted on a popular website).
*You can always send a message to another echo server. Here are two echo addresses:
** BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb
** BM-omXeTjutKWmYgQJjmoZjAG3u3NmaLEdZK
*You may subscribe to the [[Timeservice Broadcast]] to receive network heartbeats.
*You can send messages to a [[Mailing List]] in case it still does not works
If you still do not receive a response, [https://bitmessage.org/forum/index.php visit the forum] to see if there is a current technical issue or to submit a new request for assistance.

===Other===
Here is a list of average times for different parts of Bitmessage. [[PyBitmessage Help]]

Please [https://bitmessage.org/forum/index.php visit the forum] for all other issues.

FAQ

2013-10-12T12:06:12Z

AyrA: /* How does Bitmessage compare to other messaging methods */ more colors

==Installation and configuration==
===How do I install Bitmessage===
Bitmessage does not needs to be "installed". it is simply downloaded and executed. You can find instructions to download and run bitmessage from the [[Main Page]].
A great write up for setting up and using Bitmessage on Windows can be found [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ Here.]

Bitmessage should run on any OS though it is only lightly tested on OSX. The start-on-boot and minimize-to-tray features are only implemented for Windows thus far. Several examples of how to install Bitmessage on *nix and OSX platforms can be found [https://bitmessage.org/forum/index.php in the forums.]

===How do I become a node to help the network===
If your connection indicator is green then you are already accepting incoming connections and helping the Bitmessage network.

If your connection indicator is yellow, check your firewall settings and port forwarding to make sure incoming connections are allowed to your machine on the correct TCP port (Default: 8444), the port can be found in the Bitmessage settings.

You can click on the indicator for more information about each color.

===Why is my Connection Indicator Yellow===
Bitmessage will work normally with a yellow indicator. If your indicator is yellow, you can have up to 8 connections. To make your indicator green, please forward the required TCP port (usually 8444). You can find the Port in the Bitmessage settings.

===How do I setup Bitmessage to work with Tor===

'''Tor'''

If you are using the Tor Browser Bundle skip to the next section. In order for Bitmessage to use Tor as a proxy follow these steps.
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9050'.
*Select ok.
*Restart Bitmessage.

'''Tor Browser Bundle'''
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9150'.
*Select ok.
*Restart Bitmessage.

==Usage==
===How can I run Bitmessage in daemon mode===
Refer to the [[Daemon|Daemon Mode Page]].

===How many connections should I have===
As long as you have at least one connection, you can communicate with the network. If your connection indicator is yellow, you can have a maximum of 8 connections.

===Can I send a message to someone that is offline===
Yes. However, if you go offline then they must come back online within 2 days of the message being sent. Nodes delete data, and do not accept data, older than 2 days.

===How do I format my messages===
Here is [https://qt-project.org/doc/qt-4.8/richtext-html-subset.html the list of supported HTML tags].

===What are subscriptions?===

A [[Subscriptions|subscription]] allows you to receive messages, that were broadcasted by the address you subscribe too.
Since [[broadcast]] messages are encrypted with a key, that can be created by everyone who knows the address, you must be subscribed to an address to actually read the messages.

Subscriptions are also required to use a [[Mailing List]].

===What are "chans"?===
Chan is another word for DML. Please refer to [[DML|this article]] for a complete documentation of this rather complex feature.

==How does Bitmessage work==
'''Startup'''

When you first start Bitmessage, your client connects itself to the network and starts downloading a list of known nodes. Each new node that you connect to shares its list of known nodes. In addition to the known nodes, you will also start receiving person-to-person messages, broadcasts, and public keys. If any of these messages are bound for you, they will be shown in your inbox. All of this data is exchanged between all of your connections to make sure that everyone has a copy.

'''Sending a Message'''

When you send a message, your client must first compute a Proof of Work (POW). This POW helps mitigate spam on the network. Nodes and other clients will not process your message if it does not show sufficient POW. After the POW is complete, your message is shared to all of your connections which in turn share it with all of their connections.

===Where can I find more documentation about Bitmessage===
* [https://bitmessage.org/bitmessage.pdf Overview White Paper (PDF)]
* [[Protocol specification]]
* Detail about the [[Proof of work]]

==How does Bitmessage compare to other messaging methods==
Here is a table comparing Bitmessage to other common messaging services.

{| border="1" class="wikitable"
|+ Comparison of Messaging Services
!  
! Trustless
! P2P
! Open Source
! Requires Proof of Work
! Hide Sender?
! Hide Receiver?
! Mobile Version
! Application or Web Based
! Text Only Messages
! Attachments
! Acknowledge delivery
|-
! Bitmessage
| {{Yes}}
| {{Yes}}
| [http://opensource.org/licenses/mit-license.php MIT]
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{No}}
| {{Partial|Small only}}
| {{Yes}}
|-
! Standard Email
|
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{No}}
| {{Yes}}
| {{No}}
|-
! Email + GPG
| {{Yes}}
| {{No}}
| {{Partial|Depends}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
| {{No}}
|-
! [http://xmpp.org/ XMPP] + [https://en.wikipedia.org/wiki/Off-the-Record_Messaging OTR]
| {{Yes}}
| {{No}}
| {{Yes|GPL V2.1}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [http://www.skype.com/en/ Skype]
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [http://www.scayl.com/ Scayl]
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Alpha
| Application
| {{No}}
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/I2P#E-mail I2P Bote]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL V3}}
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
! [https://crypto.cat/ CryptoCat]
| {{No}}
| {{No}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC]
|
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! SMS
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [http://retroshare.sourceforge.net/ RetroShare]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
|
|
|
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/Freenet#Tools_and_applications Freenet + Frost]
| {{Yes}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + FMS]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + Freemail] 0.2
| {{No}}
| {{Yes}}
| {{Yes|GPL}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [https://wiki.freenetproject.org/FLIP Freenet + FLIP]
| {{Yes}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
|
| {{Yes}}
|
| {{No}}
| {{Partial|Via Tor}}
| {{Partial|Via Tor}}
|
| Application
|
| {{Yes}}
|
|}

==Troubleshooting==
===My Connection Indicator is Red===
Check your connection settings.
Check if you can access the internet. In case you have a firewall with outgoing restrictions (not Windoes firewall) allow unrestricted access for Bitmessage through your firewall.
Sometimes Bitmessage takes time to connect to the network, especially if [[knownnodes.dat]] is large. Please allow at least 30 minutes for it to connect before posting to the forum.
You can also try deleting [[knownnodes.dat]].

If none of that works, [https://bitmessage.org/forum/index.php please visit the forum here.]

===I have not received a reply from the Echo Server===
*Your connection indicator should be yellow or green.
*Make sure that your POW is complete and the message has been sent. You should see an acknowledgement under "Status" on the "Sent" tab.
*On average it should take 8 minutes from the time you click the send button to the time you receive a response.
*Be sure to allow extra time in the event that the server is under heavy traffic (Example: An article about Bitmessage was posted on a popular website).
*You can always send a message to another echo server. Here are two echo addresses:
** BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb
** BM-omXeTjutKWmYgQJjmoZjAG3u3NmaLEdZK
*You may subscribe to the [[Timeservice Broadcast]] to receive network heartbeats.
*You can send messages to a [[Mailing List]] in case it still does not works
If you still do not receive a response, [https://bitmessage.org/forum/index.php visit the forum] to see if there is a current technical issue or to submit a new request for assistance.

===Other===
Here is a list of average times for different parts of Bitmessage. [[PyBitmessage Help]]

Please [https://bitmessage.org/forum/index.php visit the forum] for all other issues.

Template:Partial

2013-10-12T12:04:24Z

AyrA: changed param

<noinclude>{| class="wikitable"
|-
|</noinclude>style="background: #ff9000; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|}}}" class="table-yes"|{{{1|Partial}}}<noinclude>
|}
</noinclude>

FAQ

2013-10-12T12:01:02Z

AyrA: /* How does Bitmessage compare to other messaging methods */ colors!

==Installation and configuration==
===How do I install Bitmessage===
Bitmessage does not needs to be "installed". it is simply downloaded and executed. You can find instructions to download and run bitmessage from the [[Main Page]].
A great write up for setting up and using Bitmessage on Windows can be found [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ Here.]

Bitmessage should run on any OS though it is only lightly tested on OSX. The start-on-boot and minimize-to-tray features are only implemented for Windows thus far. Several examples of how to install Bitmessage on *nix and OSX platforms can be found [https://bitmessage.org/forum/index.php in the forums.]

===How do I become a node to help the network===
If your connection indicator is green then you are already accepting incoming connections and helping the Bitmessage network.

If your connection indicator is yellow, check your firewall settings and port forwarding to make sure incoming connections are allowed to your machine on the correct TCP port (Default: 8444), the port can be found in the Bitmessage settings.

You can click on the indicator for more information about each color.

===Why is my Connection Indicator Yellow===
Bitmessage will work normally with a yellow indicator. If your indicator is yellow, you can have up to 8 connections. To make your indicator green, please forward the required TCP port (usually 8444). You can find the Port in the Bitmessage settings.

===How do I setup Bitmessage to work with Tor===

'''Tor'''

If you are using the Tor Browser Bundle skip to the next section. In order for Bitmessage to use Tor as a proxy follow these steps.
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9050'.
*Select ok.
*Restart Bitmessage.

'''Tor Browser Bundle'''
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9150'.
*Select ok.
*Restart Bitmessage.

==Usage==
===How can I run Bitmessage in daemon mode===
Refer to the [[Daemon|Daemon Mode Page]].

===How many connections should I have===
As long as you have at least one connection, you can communicate with the network. If your connection indicator is yellow, you can have a maximum of 8 connections.

===Can I send a message to someone that is offline===
Yes. However, if you go offline then they must come back online within 2 days of the message being sent. Nodes delete data, and do not accept data, older than 2 days.

===How do I format my messages===
Here is [https://qt-project.org/doc/qt-4.8/richtext-html-subset.html the list of supported HTML tags].

===What are subscriptions?===

A [[Subscriptions|subscription]] allows you to receive messages, that were broadcasted by the address you subscribe too.
Since [[broadcast]] messages are encrypted with a key, that can be created by everyone who knows the address, you must be subscribed to an address to actually read the messages.

Subscriptions are also required to use a [[Mailing List]].

===What are "chans"?===
Chan is another word for DML. Please refer to [[DML|this article]] for a complete documentation of this rather complex feature.

==How does Bitmessage work==
'''Startup'''

When you first start Bitmessage, your client connects itself to the network and starts downloading a list of known nodes. Each new node that you connect to shares its list of known nodes. In addition to the known nodes, you will also start receiving person-to-person messages, broadcasts, and public keys. If any of these messages are bound for you, they will be shown in your inbox. All of this data is exchanged between all of your connections to make sure that everyone has a copy.

'''Sending a Message'''

When you send a message, your client must first compute a Proof of Work (POW). This POW helps mitigate spam on the network. Nodes and other clients will not process your message if it does not show sufficient POW. After the POW is complete, your message is shared to all of your connections which in turn share it with all of their connections.

===Where can I find more documentation about Bitmessage===
* [https://bitmessage.org/bitmessage.pdf Overview White Paper (PDF)]
* [[Protocol specification]]
* Detail about the [[Proof of work]]

==How does Bitmessage compare to other messaging methods==
Here is a table comparing Bitmessage to other common messaging services.

{| border="1" class="wikitable"
|+ Comparison of Messaging Services
!  
! Trustless
! P2P
! Open Source
! Requires Proof of Work
! Hide Sender?
! Hide Receiver?
! Mobile Version
! Application or Web Based
! Text Only Messages
! Attachments
! Acknowledge delivery
|-
! Bitmessage
| {{Yes}}
| {{Yes}}
| [http://opensource.org/licenses/mit-license.php MIT]
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{No}}
| {{Partial|Small only}}
| {{Yes}}
|-
! Standard Email
|
| {{No}}
| Depends
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{No}}
| {{Yes}}
| {{No}}
|-
! Email + GPG
| {{Yes}}
| {{No}}
| Depends
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
| {{No}}
|-
! [http://xmpp.org/ XMPP] + [https://en.wikipedia.org/wiki/Off-the-Record_Messaging OTR]
| {{Yes}}
| {{No}}
| GPL V2.1
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
| {{Yes}}
| {{Yes}}
| GPL
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [http://www.skype.com/en/ Skype]
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
|
|-
! [http://www.scayl.com/ Scayl]
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Alpha
| Application
| {{No}}
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/I2P#E-mail I2P Bote]
| {{Yes}}
| {{Yes}}
| GPL V3
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
! [https://crypto.cat/ CryptoCat]
| {{No}}
| {{No}}
| GPL
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC]
|
| {{No}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Both
| {{Yes}}
| {{No}}
|
|-
! SMS
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{Yes}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [http://retroshare.sourceforge.net/ RetroShare]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
|
|
|
| {{Yes}}
|
|-
! [https://en.wikipedia.org/wiki/Freenet#Tools_and_applications Freenet + Frost]
| {{Yes}}
| {{Yes}}
| GPL
| {{No}}
| {{Yes}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{Yes}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + FMS]
| {{No}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{Yes}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + Freemail] 0.2
| {{No}}
| {{Yes}}
| GPL
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{No}}
| {{Yes}}
| {{No}}
|-
! [https://wiki.freenetproject.org/FLIP Freenet + FLIP]
| {{Yes}}
| {{Yes}}
|
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| Application
| {{Yes}}
| {{No}}
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
|
| {{Yes}}
|
| {{No}}
| Via Tor
| Via Tor
|
| Application
|
| {{Yes}}
|
|}

==Troubleshooting==
===My Connection Indicator is Red===
Check your connection settings.
Check if you can access the internet. In case you have a firewall with outgoing restrictions (not Windoes firewall) allow unrestricted access for Bitmessage through your firewall.
Sometimes Bitmessage takes time to connect to the network, especially if [[knownnodes.dat]] is large. Please allow at least 30 minutes for it to connect before posting to the forum.
You can also try deleting [[knownnodes.dat]].

If none of that works, [https://bitmessage.org/forum/index.php please visit the forum here.]

===I have not received a reply from the Echo Server===
*Your connection indicator should be yellow or green.
*Make sure that your POW is complete and the message has been sent. You should see an acknowledgement under "Status" on the "Sent" tab.
*On average it should take 8 minutes from the time you click the send button to the time you receive a response.
*Be sure to allow extra time in the event that the server is under heavy traffic (Example: An article about Bitmessage was posted on a popular website).
*You can always send a message to another echo server. Here are two echo addresses:
** BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb
** BM-omXeTjutKWmYgQJjmoZjAG3u3NmaLEdZK
*You may subscribe to the [[Timeservice Broadcast]] to receive network heartbeats.
*You can send messages to a [[Mailing List]] in case it still does not works
If you still do not receive a response, [https://bitmessage.org/forum/index.php visit the forum] to see if there is a current technical issue or to submit a new request for assistance.

===Other===
Here is a list of average times for different parts of Bitmessage. [[PyBitmessage Help]]

Please [https://bitmessage.org/forum/index.php visit the forum] for all other issues.

Template:Partial

2013-10-12T11:59:37Z

AyrA: Created partial

Template:No

2013-10-12T11:53:48Z

AyrA: Created No

<noinclude>{| class="wikitable"
|-
|</noinclude>style="background: #ff9090; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|}}}" class="table-yes"|{{{0|No}}}<noinclude>
|}
</noinclude>

Template:Yes

2013-10-12T11:52:19Z

AyrA: Created Yes

<noinclude>{| class="wikitable"
|-
|</noinclude>style="background: #90ff90; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|}}}" class="table-yes"|{{{1|Yes}}}<noinclude>
|}
</noinclude>

PyBitmessage Help

2013-10-01T22:13:15Z

AyrA: /* Interface language */ info about non-working feature

Welcome to the help page for PyBitmessage.

== Clarification ==
PyBitmessage is the official client, used as protocol reference. It is usually abbreviated "Bitmessage", causing confusion between the protocol and the client.

== Initial setup ==
PyBitmessage can be downloaded from the [[Main Page]], either as Windows binary or as source from github. Other builds (for example for Mac OS X) can be found in the forum.
The client sets up itself completely automatic. It can be launched and the required files for its operation are created if they do not exist.

== Daily usage ==
[[File:PyBitmessage-Sent.png|300px|thumb|right|Main window with sent tab open]]
PyBitmessage will automatically connect to other clients on start up, the user does not needs to wait for this to complete and can instantly send messages. [[POW]] can be made if offline.
The Main interface contains the folowing tabs:

=== Inbox ===
The inbox contains all your received messages (top part) and displays the currently selected message (bottom part). The bottom window allows copying and editing the message but it will not be saved. The context menu in the message list provides additional features, such as [[HTML view]], save as text file and a reply option. Using the HTML view renders some HTML tags from the message, for example images.
Messages that are no longer needed can be sent to the trash with the [DEL] key.

=== Send ===
The "Send" tab is used to compose new private or [[Broadcast]] messages. A message can be dedicated to multiple people but the protocol supports only one receiving address per message. Example: Sending a message to 8 people will generate the exact same message 8 times in the "Sent" tab.

=== Sent ===
The sent tab displays messages sent by the user, including messages that are in the process of [[POW|proof of work]]. The status column displays the current status of the message.
Table with the most common messages:
{| class="wikitable" border="1"
|-
! Status
! Description
|-
| Doing work necessary to send <type>...
| [[POW]] is being done
|-
| <type> sent on <date/time>
| The message has been sent
|-
| Waiting on Acknowledgement
| The message has been sent but the receiver has not received it yet. Not applicable for broadcasts
|-
| Acknowledgement received on <date+time>
| The receiver got the message. Not applicable for broadcasts
|}
Messages can be sent to the trash with the [DEL] key however, this will not stop POW from being made if it has already started.

=== Your Identities ===
Contains a list of all addresses stored in [[keys.dat]] and allows to generate new ones. The context menu allows to enable/disable addresses. Addresses can be labeled, this label is then displayed instead of the address. Labels are not sent over the network and are only visible to the client. Addresses cannot be deleted directly in this tab, but removing the [[Address Block]] from keys.dat removes it. Editing the keys.dat file requires the user to shut down the client first.

=== [[Subscriptions]] ===
Contains a list of all [[Broadcast|broadcasts]], that the client will receive. To receive broadcasts its address must be added first to the list. The context menu allows enabling, disabling and deletation of addresses.

=== Address Book ===
Can be used to associate addresses with labels for easier recognition.
The context menu allows the user to add a subscription to the address.

=== Blacklist/Whitelist ===
Addresses can be blacklisted or whitelisted. The Operation mode of the list (whitelist or blacklist) ban be set too. The context menu allows entries to be enabled, disabled or deleted.

=== Network Status ===
Shows the [[Stream]] number and the number of connected nodes in a list. Displays when it was started and how much information has been processed yet.
Detailed information about the icon color and how to get a green icon can be found [[Network Status|here]]

== [[DML]] Addresses ==
A DML Address can be either created or joined in the '''File > Join / Create chan''' menu.
These addresses are written with orange color in the identities tab.

To learn more about how to use a DML Address / chan, visit [[DML|this article]].
You need to either create the address or join it to send messages to it, else the client gets stuck when waiting for the public key. To resolve this issue, without joining or creating an address see, the DML article.

=== Join ===
To Join a DML, the address and the passphrase is required. The passphrase is used to generate the private keys, that the client needs to send and receive messages. The address is used so the user does not needs to know the stream number and address version. If the address is not known, a DML can be created, even if it actually exists, in the hope, that the resulting address is correct.

=== Create ===
Creating a DML/chan only requires a passphrase. It will create the address and mark it as such.

=== Notes ===
There is no technical difference between creation and joining. Joining requires the address to make sure, you actually get the correct private keys, because they depend on stream number and address version, which are both included in the address.
Creating an address however will always use the newest address version and stream number and thus may create a different address, which is not compatible with the one intended to join.

== Configuration ==
Bitmessage can be configured by editing [[keys.dat]] or by using the menu '''Settings > Settings''' in the GUI.

=== Settings Menu ===
The settings menu has the folowing tabs:

==== User Interface ====
Allows customization how bitmessage is started and if it should run in portable mode or not.

===== Willingly include... =====
'''Willingly include unencrypted destination address when sending to a mobile device'''

This option must be enabled, when using [[DML]] addresses and is a work in progress feature for mobile app support and has nothing to do with the user interface.

===== Interface language =====
This option is currently (at least in the compiled windows version) not fully working but allows to set the language of the client.

==== Network Settings ====
Allows setting of the TCP port used for incomming connections. This can be left at default value for most users.
A proxy server can be defined if the user wishes to do so. Supports SOCKS4a and SOCKS5 with Authentication support.
The option to allow incoming connections can be enabled if the user wishes to help the network, even when using a proxy. Incoming connections '''are not''' routed over the socks proxy!

==== Demanded Difficulty ====
The demanded difficulty allows to increase the amount of POW to be done for other clients to send messages to the user.
POW for users in the address book is always 1. Doubling the number doubles the amount of time required.

The value for small difficulty defaults to 1.0, rthe value for large difficulty to 2.0 (since version 0.4.0)

==== Max acceptable difficulty ====
Similar to the "demanded difficulty" tab, this tab has the exact same textboxes, however, they are used to limit the amount of POW the user is willing to do. If he sends a message and the destination address wants him to do more POW than he set as maximum, the message will not be processed. The user can click with the right mouse button on the message and force it to be sent or he can delete the message.

== Database cleanup ==
The database ([[messages.dat]]) can be cleaned and shrinked manually with the menu '''File > Delete all trashed messages'''.
The database is compacted once every month automatically without deletation of trashed messages.

== Statistics ==
=== Time ===
On an average computer, different processes take different amounts of time.
{| class="wikitable"
|-
! Action !! Time required
|-
| Generate an address || 1 second*
|-
| Generate an address (1 or 2 characters shorter) || 5 minutes*
|-
| Sender do work necessary to send broadcast|| 2 minutes
|-
| Sender do work necessary to send person-to-person message|| 4 minutes
|-
| message (or acknowledgement data) propagate through the network|| 10 seconds
|}
Note that on Linux and OSX systems, Bitmessage can often do work much faster as it is able to use all available cores and a faster hashing module.

<nowiki>*</nowiki> After this step is done, the client will silently do work to send out the public key over the network which will take about 2 minutes.

PyBitmessage Help

2013-10-01T22:12:16Z

AyrA: /* Network Status */ added link for icons

Welcome to the help page for PyBitmessage.

== Clarification ==
PyBitmessage is the official client, used as protocol reference. It is usually abbreviated "Bitmessage", causing confusion between the protocol and the client.

== Initial setup ==
PyBitmessage can be downloaded from the [[Main Page]], either as Windows binary or as source from github. Other builds (for example for Mac OS X) can be found in the forum.
The client sets up itself completely automatic. It can be launched and the required files for its operation are created if they do not exist.

== Daily usage ==
[[File:PyBitmessage-Sent.png|300px|thumb|right|Main window with sent tab open]]
PyBitmessage will automatically connect to other clients on start up, the user does not needs to wait for this to complete and can instantly send messages. [[POW]] can be made if offline.
The Main interface contains the folowing tabs:

=== Inbox ===
The inbox contains all your received messages (top part) and displays the currently selected message (bottom part). The bottom window allows copying and editing the message but it will not be saved. The context menu in the message list provides additional features, such as [[HTML view]], save as text file and a reply option. Using the HTML view renders some HTML tags from the message, for example images.
Messages that are no longer needed can be sent to the trash with the [DEL] key.

=== Send ===
The "Send" tab is used to compose new private or [[Broadcast]] messages. A message can be dedicated to multiple people but the protocol supports only one receiving address per message. Example: Sending a message to 8 people will generate the exact same message 8 times in the "Sent" tab.

=== Sent ===
The sent tab displays messages sent by the user, including messages that are in the process of [[POW|proof of work]]. The status column displays the current status of the message.
Table with the most common messages:
{| class="wikitable" border="1"
|-
! Status
! Description
|-
| Doing work necessary to send <type>...
| [[POW]] is being done
|-
| <type> sent on <date/time>
| The message has been sent
|-
| Waiting on Acknowledgement
| The message has been sent but the receiver has not received it yet. Not applicable for broadcasts
|-
| Acknowledgement received on <date+time>
| The receiver got the message. Not applicable for broadcasts
|}
Messages can be sent to the trash with the [DEL] key however, this will not stop POW from being made if it has already started.

=== Your Identities ===
Contains a list of all addresses stored in [[keys.dat]] and allows to generate new ones. The context menu allows to enable/disable addresses. Addresses can be labeled, this label is then displayed instead of the address. Labels are not sent over the network and are only visible to the client. Addresses cannot be deleted directly in this tab, but removing the [[Address Block]] from keys.dat removes it. Editing the keys.dat file requires the user to shut down the client first.

=== [[Subscriptions]] ===
Contains a list of all [[Broadcast|broadcasts]], that the client will receive. To receive broadcasts its address must be added first to the list. The context menu allows enabling, disabling and deletation of addresses.

=== Address Book ===
Can be used to associate addresses with labels for easier recognition.
The context menu allows the user to add a subscription to the address.

=== Blacklist/Whitelist ===
Addresses can be blacklisted or whitelisted. The Operation mode of the list (whitelist or blacklist) ban be set too. The context menu allows entries to be enabled, disabled or deleted.

=== Network Status ===
Shows the [[Stream]] number and the number of connected nodes in a list. Displays when it was started and how much information has been processed yet.
Detailed information about the icon color and how to get a green icon can be found [[Network Status|here]]

== [[DML]] Addresses ==
A DML Address can be either created or joined in the '''File > Join / Create chan''' menu.
These addresses are written with orange color in the identities tab.

To learn more about how to use a DML Address / chan, visit [[DML|this article]].
You need to either create the address or join it to send messages to it, else the client gets stuck when waiting for the public key. To resolve this issue, without joining or creating an address see, the DML article.

=== Join ===
To Join a DML, the address and the passphrase is required. The passphrase is used to generate the private keys, that the client needs to send and receive messages. The address is used so the user does not needs to know the stream number and address version. If the address is not known, a DML can be created, even if it actually exists, in the hope, that the resulting address is correct.

=== Create ===
Creating a DML/chan only requires a passphrase. It will create the address and mark it as such.

=== Notes ===
There is no technical difference between creation and joining. Joining requires the address to make sure, you actually get the correct private keys, because they depend on stream number and address version, which are both included in the address.
Creating an address however will always use the newest address version and stream number and thus may create a different address, which is not compatible with the one intended to join.

== Configuration ==
Bitmessage can be configured by editing [[keys.dat]] or by using the menu '''Settings > Settings''' in the GUI.

=== Settings Menu ===
The settings menu has the folowing tabs:

==== User Interface ====
Allows customization how bitmessage is started and if it should run in portable mode or not.

===== Willingly include... =====
'''Willingly include unencrypted destination address when sending to a mobile device'''

This option must be enabled, when using [[DML]] addresses and is a work in progress feature for mobile app support and has nothing to do with the user interface.

===== Interface language =====
This option is currently (at least in the compiled windows version) not working

==== Network Settings ====
Allows setting of the TCP port used for incomming connections. This can be left at default value for most users.
A proxy server can be defined if the user wishes to do so. Supports SOCKS4a and SOCKS5 with Authentication support.
The option to allow incoming connections can be enabled if the user wishes to help the network, even when using a proxy. Incoming connections '''are not''' routed over the socks proxy!

==== Demanded Difficulty ====
The demanded difficulty allows to increase the amount of POW to be done for other clients to send messages to the user.
POW for users in the address book is always 1. Doubling the number doubles the amount of time required.

The value for small difficulty defaults to 1.0, rthe value for large difficulty to 2.0 (since version 0.4.0)

==== Max acceptable difficulty ====
Similar to the "demanded difficulty" tab, this tab has the exact same textboxes, however, they are used to limit the amount of POW the user is willing to do. If he sends a message and the destination address wants him to do more POW than he set as maximum, the message will not be processed. The user can click with the right mouse button on the message and force it to be sent or he can delete the message.

== Database cleanup ==
The database ([[messages.dat]]) can be cleaned and shrinked manually with the menu '''File > Delete all trashed messages'''.
The database is compacted once every month automatically without deletation of trashed messages.

== Statistics ==
=== Time ===
On an average computer, different processes take different amounts of time.
{| class="wikitable"
|-
! Action !! Time required
|-
| Generate an address || 1 second*
|-
| Generate an address (1 or 2 characters shorter) || 5 minutes*
|-
| Sender do work necessary to send broadcast|| 2 minutes
|-
| Sender do work necessary to send person-to-person message|| 4 minutes
|-
| message (or acknowledgement data) propagate through the network|| 10 seconds
|}
Note that on Linux and OSX systems, Bitmessage can often do work much faster as it is able to use all available cores and a faster hashing module.

<nowiki>*</nowiki> After this step is done, the client will silently do work to send out the public key over the network which will take about 2 minutes.