mirror of https://github.com/c-ares/c-ares.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
69 lines
3.8 KiB
69 lines
3.8 KiB
# [![c-ares logo](https://c-ares.org/art/c-ares-logo.svg)](https://c-ares.org/) |
|
|
|
[![Build Status](https://api.cirrus-ci.com/github/c-ares/c-ares.svg?branch=main)](https://cirrus-ci.com/github/c-ares/c-ares) |
|
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/aevgc5914tm72pvs/branch/main?svg=true)](https://ci.appveyor.com/project/c-ares/c-ares/branch/main) |
|
[![Coverage Status](https://coveralls.io/repos/github/c-ares/c-ares/badge.svg)](https://coveralls.io/github/c-ares/c-ares) |
|
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/291/badge)](https://bestpractices.coreinfrastructure.org/projects/291) |
|
[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/c-ares.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:c-ares) |
|
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=c-ares_c-ares&metric=bugs)](https://sonarcloud.io/summary/new_code?id=c-ares_c-ares) |
|
[![Coverity Scan Status](https://scan.coverity.com/projects/c-ares/badge.svg)](https://scan.coverity.com/projects/c-ares) |
|
|
|
## Overview |
|
[c-ares](https://c-ares.org) is a modern DNS (stub) resolver library, written in |
|
C. It provides interfaces for asynchronous queries while trying to abstract the |
|
intricacies of the underlying DNS protocol. It was originally intended for |
|
applications which need to perform DNS queries without blocking, or need to |
|
perform multiple DNS queries in parallel. |
|
|
|
One of the goals of c-ares is to be a better DNS resolver than is provided by |
|
your system, regardless of which system you use. We recommend using |
|
the c-ares library in all network applications even if the initial goal of |
|
asynchronous resolution is not necessary to your application. |
|
|
|
c-ares will build with any C89 compiler, is [MIT licensed](LICENSE.md), |
|
which makes it suitable for both free and commercial software. c-ares runs on |
|
Linux, FreeBSD, OpenBSD, MacOS, Solaris, AIX, Windows, Android, iOS and many |
|
more operating systems. |
|
|
|
c-ares has a strong focus on security, implementing safe parsers and data |
|
builders used throughout the code, thus avoiding many of the common pitfalls |
|
of other C libraries. Through automated testing with our extensive testing |
|
framework, c-ares is constantly validated with a range of static and dynamic |
|
analyzers, as well as being constantly fuzzed by [OSS Fuzz](https://github.com/google/oss-fuzz). |
|
|
|
While c-ares has been around for over 20 years, it has been actively maintained |
|
both in regards to the latest DNS RFCs as well as updated to follow the latest |
|
best practices in regards to C coding standards. |
|
|
|
This is c-ares, an asynchronous resolver library. It is intended for |
|
applications which need to perform DNS queries without blocking, or need to |
|
perform multiple DNS queries in parallel. The primary examples of such |
|
applications are servers which communicate with multiple clients and programs |
|
with graphical user interfaces. |
|
|
|
## Code |
|
|
|
The full source code and revision history is available in our |
|
[GitHub repository](https://github.com/c-ares/c-ares). Our signed releases |
|
are available in the ['c-ares' release archives](https://c-ares.org/download/). |
|
|
|
|
|
See the [INSTALL.md](INSTALL.md) file for build information. |
|
|
|
## Communication |
|
|
|
**Issues** and **Feature Requests** should be reported to our |
|
[GitHub Issues](https://github.com/c-ares/c-ares/issues) page. |
|
|
|
**Discussions** around c-ares and its use, are held on |
|
[GitHub Discussions](https://github.com/c-ares/c-ares/discussions/categories/q-a) |
|
or the [Mailing List](https://lists.haxx.se/mailman/listinfo/c-ares). Mailing |
|
List archive [here](https://lists.haxx.se/pipermail/c-ares/). |
|
Please, do not mail volunteers privately about c-ares. |
|
|
|
**Security vulnerabilities** are treated according to our |
|
[Security Procedure](SECURITY.md), please email c-ares-security at |
|
haxx.se if you suspect one. |
|
|
|
|
|
|
|
|