Go to file
Alex Crichton 743d926d9e rollup merge of #20488: ltratt/nondeterministic_tempdir
The previous scheme made it possible for another user/attacker to cause the
temporary directory creation scheme to panic. All you needed to know was the pid
of the process you wanted to target ('other_pid') and the suffix it was using
(let's pretend it's 'sfx') and then code such as this would, in essence, DOS it:

    for i in range(0u, 1001) {
        let tp = &Path::new(format!("/tmp/rs-{}-{}-sfx", other_pid, i));
        match fs::mkdir(tp, io::USER_RWX) { _ => () }
    }

Since the scheme only 1000 times to create a temporary directory before dying,
the next time the attacked process called TempDir::new("sfx") after that would
typically cause a panic. Of course, you don't necessarily need an attacker to
cause such a DOS: creating 1000 temporary directories without closing any of the
previous would be enough to DOS yourself.

This patch broadly follows the OpenBSD implementation of mkstemp. It uses the
operating system's random number generator to produce random directory names
that are impractical to guess (and, just in case someone manages to do that, it
retries creating the directory for a long time before giving up; OpenBSD
retries INT_MAX times, although 1<<31 seems enough to thwart even the most
patient attacker).

As a small additional change while the file name is changing, this patch also
makes the argument that TempDir::new takes a prefix rather than a suffix.
This is because 1) it more closely matches what mkstemp and friends do 2)
if you're going to have a deterministic part of a filename, you really want it at
the beginning so that shell completion is useful.
2015-01-05 18:37:20 -08:00
man Man page/--help dialog fix 2015-01-03 11:34:01 -08:00
mk rollup merge of #19998: th0114nd/unicode-bottom 2015-01-05 18:36:20 -08:00
src rollup merge of #20488: ltratt/nondeterministic_tempdir 2015-01-05 18:37:20 -08:00
.gitattributes webfonts: proper fix 2014-07-08 20:29:36 +02:00
.gitignore gitignore: Add the autogenerated/downloaded unicode data files. 2014-08-03 17:32:53 +10:00
.gitmodules Use rust-installer for installation 2014-12-11 17:14:17 -08:00
.mailmap Update .mailmap 2014-10-23 23:01:31 +02:00
.travis.yml Allow travis to use newer-faster infrastructure for building. http://blog.travis-ci.com/2014-12-17-faster-builds-with-container-based-infrastructure/ 2015-01-01 02:00:29 -05:00
AUTHORS.txt Add myself to authors. 2014-12-22 10:49:47 +01:00
CONTRIBUTING.md Put links to discuss.rust-lang.org and #rust-internals in CONTRIBUTING.md 2015-01-02 15:42:38 -08:00
COPYRIGHT Update COPYRIGHT to better reflect the current repo 2014-10-06 10:55:39 -07:00
LICENSE-APACHE
LICENSE-MIT
Makefile.in Fix incorrect link in Makefile.in documentation 2014-12-28 22:42:12 +01:00
README.md auto merge of #17876 : ruud-v-a/rust/patch-1, r=alexcrichton 2014-10-13 21:32:43 +00:00
RELEASES.md More relnotes tweaks 2014-10-07 13:44:41 -07:00
configure Initial version of AArch64 support. 2015-01-03 15:16:10 +00:00

README.md

The Rust Programming Language

This is a compiler for Rust, including standard libraries, tools and documentation.

Quick Start

  1. Download a binary installer for your platform.
  2. Read the guide.
  3. Enjoy!

Note: Windows users can read the detailed using Rust on Windows notes on the wiki.

Building from Source

  1. Make sure you have installed the dependencies:

    • g++ 4.7 or clang++ 3.x
    • python 2.6 or later (but not 3.x)
    • perl 5.0 or later
    • GNU make 3.81 or later
    • curl
    • git
  2. Download and build Rust:

    You can either download a tarball or build directly from the repo.

    To build from the tarball do:

     $ curl -O https://static.rust-lang.org/dist/rust-nightly.tar.gz
     $ tar -xzf rust-nightly.tar.gz
     $ cd rust-nightly
    

    Or to build from the repo do:

     $ git clone https://github.com/rust-lang/rust.git
     $ cd rust
    

    Now that you have Rust's source code, you can configure and build it:

     $ ./configure
     $ make && make install
    

    Note: You may need to use sudo make install if you do not normally have permission to modify the destination directory. The install locations can be adjusted by passing a --prefix argument to configure. Various other options are also supported, pass --help for more information on them.

    When complete, make install will place several programs into /usr/local/bin: rustc, the Rust compiler, and rustdoc, the API-documentation tool.

  3. Read the guide.

  4. Enjoy!

Building on Windows

To easily build on windows we can use MSYS2:

  1. Grab the latest MSYS2 installer and go through the installer.

  2. Now from the MSYS2 terminal we want to install the mingw64 toolchain and the other tools we need.

     $ pacman -S mingw-w64-i686-toolchain
     $ pacman -S base-devel
    
  3. With that now start mingw32_shell.bat from where you installed MSYS2 (i.e. C:\msys).

  4. From there just navigate to where you have Rust's source code, configure and build it:

     $ ./configure
     $ make && make install
    

Notes

Since the Rust compiler is written in Rust, it must be built by a precompiled "snapshot" version of itself (made in an earlier state of development). As such, source builds require a connection to the Internet, to fetch snapshots, and an OS that can execute the available snapshot binaries.

Snapshot binaries are currently built and tested on several platforms:

  • Windows (7, 8, Server 2008 R2), x86 and x86-64 (64-bit support added in Rust 0.12.0)
  • Linux (2.6.18 or later, various distributions), x86 and x86-64
  • OSX 10.7 (Lion) or greater, x86 and x86-64

You may find that other platforms work, but these are our officially supported build environments that are most likely to work.

Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits swap, it will take a very long time to build.

There is a lot more documentation in the wiki.

Getting help and getting involved

The Rust community congregates in a few places:

License

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.