Magnet URI scheme
This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these template messages)(Learn how and when to remove this template message)
Although magnet links can be used in a number of contexts, they are particularly useful in peer-to-peer file sharing networks because they allow resources to be referred to without the need for a continuously available host, and can be generated by anyone who already has the file, without the need for a central authority to issue them. This makes them popular for use as "guaranteed" search terms within the file sharing community where anyone can distribute a magnet link to ensure that the resource retrieved by that link is the one intended, regardless of how it is retrieved.
- 1 History
- 2 Technical description
- 3 Design
- 3.1 Parameters
- 3.2 URN, containing hash (xt)
- 3.3 Web links to the file
- 3.4 Manifest (mt)
- 3.5 Keywords (kt)
- 3.6 Address tracker (tr)
- 3.7 Supplement format (x.)
- 3.8 Group settings
- 4 Examples
- 5 Features and clients
- 6 See also
- 7 Notes
- 8 References
- 9 External links
The standard for Magnet URIs was developed by Bitzi in 2002, partly as a "vendor- and project-neutral generalization" of the
freenet: URI schemes used by eDonkey2000 and Freenet, respectively, and attempts to follow official IETF URI standards as closely as possible.
Magnet URIs consist of a series of one or more parameters, the order of which is not significant, formatted in the same way as query strings that ordinarily terminate HTTP URLs. The most common parameter is "xt" ("exact topic"), which is generally a URN formed from the content hash of a particular file, e.g.:
This refers to the hex-encoded SHA-1 hash of the torrent file info section in question. Note that, although a particular file is indicated, an availability search for it must still be carried out by the client application.
Other parameters defined by the draft standard are:
- "dn" ("display name"): a filename to display to the user, for convenience
- "kt" ("keyword topic"): a more general search, specifying search terms, rather than a particular file
- "mt" ("manifest topic"): a URI pointing to a "manifest", e.g. a list of further items
- application-specific experimental parameters, which must begin "x."
The standard also allows for multiple parameters of the same type to be used by appending ".1", ".2", etc. to the parameter name, e.g.:
Magnet URIs can contain multiple parameters, in any order, separated from each other by '&'.
- dn (Display Name) – Filename
- xl (eXact Length) – Size in bytes
- xt (eXact Topic) – URN containing file hash
- as (Acceptable Source) – Web link to the file online
- xs (eXact Source) – P2P link
- kt (Keyword Topic) – Key words for search
- mt (Manifest Topic) – link to the metafile that contains a list of magneto (MAGMA – MAGnet MAnifest)
- tr (address TRacker) – Tracker URL for BitTorrent downloads
URN, containing hash (xt)
"xt" ("exact topic"): the most important part of a Magnet link and is used to find and verify the specified files.
Tiger Tree Hash (TTH)
Secure Hash Algorithm 1 (SHA-1)
These hash sums are used on eDonkey2000.
Not formal URNs for Magnet links, such hash sums are used by eDonkey2000 to restore and control the integrity of downloading and already downloaded files.
BitTorrent info hash (BTIH)
These are hex-encoded SHA-1 hash sums of the "info" sections of BitTorrent metafiles as used by BitTorrent to identify downloadable files or sets of files. For backwards compatibility with existing links, clients should also support the Base32 encoded version of the hash.
Message Digest 5 (MD5)
There are two types of download links that a Magnet link can include as a direct or backup source.
"as" ("acceptable source") refers to a direct download from a web server. Regarded as only a fall-back source in case a client is unable to locate and/or download the linked-to file in its supported P2P network(s), most clients treat it equal to the "xs" token when it comes to priority, and ignore the timeout before contacting "as" sources denoted by the specs.
- as=[ a web link to the file(URL encoded) ]
"xs" ("exact source") is either an HTTP (or HTTPS, FTP, FTPS, etc.) download source for the file pointed to by the Magnet link, the address of a P2P source for the file or the address of a hub (in the case of DC++), by which a client tries to connect directly, asking for the file and/or its sources. This field is commonly used by P2P clients to store the source, and may include the file hash.
- Content-Addressable Web URL
- Link to a DirectConnect hub to find sources for a file
This type of link connects a DirectConnect client immediately to the hub in question.
- Reference to a web-based source cache for a file on Gnutella2
In this case, the included link points, not to a client IP or direct source, but to a source cache which stores the IPs of other clients contacting it to download the same file. Once a client connects to the cache, it is served IPs for alternate sources, while its own IP is stored within the cache and forwarded to the next one connecting to the cache. This system operates similar to a BitTorrent tracker.
- Reference to an eD2k source
This is a link to a list of links (see list). Perhaps as a web link...
...or a URN
This field specifies a string of search keywords to search for in P2P networks.
Address tracker (tr)
Supplement format (x.)
For experimental and self-complementing informal options, the prefix x followed by a chosen second letter can be used.
- x.[name of the new parameter]=[data of the new parameter (URL encoded)]
Multiple files and their URNs, names and hashes in the Magnet link can be included by adding a count number preceded by a dot (".") to each link parameter.
Link to a file of zero bytes length
magnet:?xt=urn:ed2k:31D6CFE0D16AE931B73C59D7E0C089C0 &xl=0 &dn=zero_len.fil &xt=urn:bitprint:3I42H3S6NNFQ2MSVX7XZKYAYSCX5QBYJ.LWPNACQDBZRYXW3VHJVCJ64QBZNGHOHHHZWCLNQ &xt=urn:md5:D41D8CD98F00B204E9800998ECF8427E
Features and clients
dn (Display Name) – Filename xl (Exact Length) – Size in bytes xt (Exact Topic) – URN containing file hash as (Acceptable Source) – Web link to the file online xs (Exact Source) – P2P link. kt (Keyword Topic) – Key words for search mt (Manifest Topic) – link to the metafile that contains a list of magneto (MAGMA – MAGnet MAnifest) tr (Address Tracker) – Tracker URL for BitTorrent downloads
|Client||dn||xl||xt||tr||xs||as||kt||mt||Interception[Note 1]||Box[Note 2]|
||No||Dchub:[Note 3]||Dchub:[Note 3]||No||Unknown||Yes||No|
||No||Dchub:[Note 3]||Dchub:[Note 3]||Yes||Unknown||Yes||No|
(Same priority as xs)
This client is able to intercept links from within the web browser and can also handle Magnet links pasted into the search area or the "Download File or Torrent" dialogue.
Unable to intercept Magnet links from within a web browser, this client supports Magnets by offering a text box at the bottom of the client into which they can be copied and pasted. The client is able only to recognize eD2k hash, file size and name in a specific order and therefore, many valid links may not be suitable for downloading.
- ed2k URI scheme
- Named data networking
- InterPlanetary File System
- Ability to intercept Magnet links directly from within the web browser. i.e. When a Magnet link is entered into the address bar, the application will intercept the link and try to open the link itself. So if a compatible client is installed on your computer and you enter a Magnet link into your browser address bar, a window pops up asking if you want to allow that client to open the link.
- Possibility to inject the link directly into the application in question.
- Since v18.104.22.168
- BEP-9: Extension for Peers to Send Metadata Files
- Chapweske, Justin (November 29, 2001). "HTTP Extensions for a Content-Addressable Web". www-talk. W3C.
- "magnet-test.c in trunk/libtransmission; Revision 9531". Transmission.
- "magnet.c in trunk/libtransmission; Revision 9979". Transmission.