## The sudo philosophy

Sudo is a program designed to allow a sysadmin to give limited root privileges
to users and log root activity.  The basic philosophy is to give as few
privileges as possible but still allow people to get their work done.

## Where to find sudo

Before building sudo, make sure you have the current version.  The
latest sudo may always be gotten via anonymous ftp from ftp.sudo.ws
in the directory /pub/sudo/ or from the sudo web site, https://www.sudo.ws/

The distribution is sudo-M.m.tar.gz where _M_ is the major version
number and _m_ is the minor version number.  Beta versions of sudo may
also be available.  If you join the _sudo-workers_ mailing list you
will get the beta announcements (see the Mailing lists section below).

## What's new

See the NEWS file for a list of major changes in this release.  For
a complete list of changes, see the [ChangeLog](ChangeLog).
For a summary of major changes to the current stable release, see
https://www.sudo.ws/releases/stable/.

If you are upgrading from an earlier version of Sudo, read
[docs/UPGRADE.md](docs/UPGRADE.md) for information on changes in
behavior that may affect you.

For a history of sudo see [docs/HISTORY.md](docs/HISTORY.md).
You can find a list of contributors to sudo in
[docs/CONTRIBUTORS.md](docs/CONTRIBUTORS.md).

## Building the release

Read the installation guide, [INSTALL.md](INSTALL.md), before trying
to build sudo.  Pay special attention to the "OS dependent notes" section.

## How to contribute

See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for information on
how you can help contribute to sudo.

## Copyright

Sudo is distributed under an ISC-style license.
Refer to [LICENSE.md](LICENSE.md) for details.

## SAST Tools

[PVS-Studio](https://pvs-studio.com/en/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source) - static analyzer for C, C++, C#, and Java code.

[Coverity Static Analysis](https://www.blackduck.com/static-analysis-tools-sast/coverity.html)

[CodeQL](https://codeql.github.com)

[Clang Static Analyzer](https://clang-analyzer.llvm.org)

[Cppcheck](http://cppcheck.net)

## Mailing lists

#### sudo-announce

This list receives announcements whenever a new version of sudo is
released.  https://www.sudo.ws/mailman/listinfo/sudo-announce

#### sudo-blog

This list receives a message when a new sudo blog article is
available.  https://www.sudo.ws/mailman/listinfo/sudo-blog

#### sudo-commits

This list receives a message for each commit made to the sudo source
repository.  https://www.sudo.ws/mailman/listinfo/sudo-commits

#### sudo-users

This list is for questions and general discussion about sudo.
https://www.sudo.ws/mailman/listinfo/sudo-users

#### sudo-workers

This list is for people working on and porting sudo.
https://www.sudo.ws/mailman/listinfo/sudo-workers

To subscribe to a list, visit its url (listed above) and enter your
email address to subscribe.  Digest versions are available but these are
fairly low traffic lists so the digest versions are not a significant win.

Mailing list archives are also available.  See the mailing list web sites
for the appropriate links.

## Sudo web page

There is a sudo web page at https://www.sudo.ws/ that contains
documentation, downloads, a bug tracker, the source repo, the sudo
blog, information about beta versions and other useful info.

## Filing bug reports/issues

If you believe you have found a bug, you can either file a bug
report in the sudo bug database, https://bugzilla.sudo.ws/, or open
a [GitHub issue](https://github.com/sudo-project/sudo/issues),
whichever you find easier.  If you would prefer to use email,
messages may be sent to the [sudo-workers@sudo.ws mailing
list](https://www.sudo.ws/mailman/listinfo/sudo-workers) (public)
or to sudo@sudo.ws (private).

For sudo's security policy and how to report security issues, see
[docs/SECURITY.md](docs/SECURITY.md).

Please check [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)
*before* submitting a bug report.  When reporting bugs, be sure to
include the version of sudo you are using, the operating system
and/or distro that is affected, and, if possible, step-by-step
instructions to reproduce the problem.
