{"id":14956623,"url":"https://github.com/mongodb/libmongocrypt","last_synced_at":"2025-11-11T20:56:45.097Z","repository":{"id":37619620,"uuid":"163867485","full_name":"mongodb/libmongocrypt","owner":"mongodb","description":"Required C library for Client Side and Queryable Encryption in MongoDB","archived":false,"fork":false,"pushed_at":"2025-04-09T19:27:56.000Z","size":17312,"stargazers_count":99,"open_issues_count":4,"forks_count":96,"subscribers_count":36,"default_branch":"master","last_synced_at":"2025-04-09T20:31:09.355Z","etag":null,"topics":["encryption","encryption-decryption-library","mongodb"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mongodb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-02T16:59:03.000Z","updated_at":"2025-04-09T19:28:00.000Z","dependencies_parsed_at":"2022-07-08T19:02:02.948Z","dependency_job_id":"b511efdd-5f7f-456f-a68d-d3105d4aa791","html_url":"https://github.com/mongodb/libmongocrypt","commit_stats":{"total_commits":1443,"total_committers":77,"mean_commits":18.74025974025974,"dds":0.6472626472626473,"last_synced_commit":"9d486e0c85bd420a047d0e49b64317349f0db9a3"},"previous_names":[],"tags_count":224,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Flibmongocrypt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Flibmongocrypt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Flibmongocrypt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Flibmongocrypt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mongodb","download_url":"https://codeload.github.com/mongodb/libmongocrypt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248819376,"owners_count":21166477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["encryption","encryption-decryption-library","mongodb"],"created_at":"2024-09-24T13:13:14.263Z","updated_at":"2025-11-11T20:56:45.086Z","avatar_url":"https://github.com/mongodb.png","language":"C","readme":"# libmongocrypt #\n\nThe companion C library for client side encryption in drivers.\n\nThis project uses [Semantic Versioning](https://semver.org/).\n\n# Bugs / Feature Requests #\n\nIf you have encountered a bug, or would like to see a new feature in libmongocrypt, please open a case in our issue management tool, JIRA:\n\n- [Create an account and login](https://jira.mongodb.org).\n- Navigate to [the MONGOCRYPT project](https://jira.mongodb.org/projects/MONGOCRYPT).\n- Click **Create Issue** - Please provide as much information as possible about the issue type and how to reproduce it.\n\n## Documentation ##\nSee [The Integration Guide](integrating.md) to integrate with your driver.\n\nSee [mongocrypt.h](src/mongocrypt.h) for the public API reference.\nThe documentation can be rendered into HTML with doxygen. Run `doxygen ./doc/Doxygen`, then open `./doc/html/index.html`.\n\n## Building libmongocrypt ##\n\nOn Windows and macOS, libmongocrypt can use the platform's default encryption\nAPIs as its encryption backend. On other systems, one will want to install the\nOpenSSL development libraries, which libmongocrypt will use as the default\nencryption backend.\n\nThen build libmongocrypt:\n\n```\ngit clone https://github.com/mongodb/libmongocrypt\ncd libmongocrypt\nmkdir cmake-build \u0026\u0026 cd cmake-build\ncmake ../\nmake\n```\n\nThis builds libmongocrypt.dylib and test-libmongocrypt, in the cmake-build\ndirectory.\n\n## Installing libmongocrypt on macOS ##\nInstall the latest release of libmongocrypt with the following.\n```\nbrew install mongodb/brew/libmongocrypt\n```\n\nTo install the latest unstable development version of libmongocrypt, use `brew install mongodb/brew/libmongocrypt --HEAD`. Do not use the unstable version of libmongocrypt in a production environment.\n\n## Building libmongocrypt from source on macOS ##\n\nFirst install [Homebrew according to its own instructions](https://brew.sh/).\n\nInstall the XCode Command Line Tools:\n```\nxcode-select --install\n```\n\nThen clone and build libmongocrypt:\n```\ngit clone https://github.com/mongodb/libmongocrypt.git\ncd libmongocrypt\ncmake .\ncmake --build . --target install\n```\n\nThen, libmongocrypt can be used with pkg-config:\n```\npkg-config libmongocrypt --libs --cflags\n```\n\nOr use cmake's `find_package`:\n```\nfind_package (mongocrypt)\n# Then link against mongo::mongocrypt\n```\n\n## Installing libmongocrypt on Windows ##\nA Windows DLL for x86_64 is available on the Github Releases page. See the [latest release](https://github.com/mongodb/libmongocrypt/releases/latest).\n\nUse `gpg` to verify the signature. The public key for `libmongocrypt` is available on https://pgp.mongodb.com/.\n\n\n### Testing ###\n`test-mongocrypt` mocks all I/O with files stored in the `test/data` and `test/example` directories. Run `test-mongocrypt` from the source directory:\n\n```\ncd libmongocrypt\n./cmake-build/test-mongocrypt\n```\n\nlibmongocrypt is continuously built and published on evergreen. Submit patch builds to this evergreen project when making changes to test on supported platforms.\nThe latest tarball containing libmongocrypt built on all supported variants is [published here](https://s3.amazonaws.com/mciuploads/libmongocrypt/all/master/latest/libmongocrypt-all.tar.gz).\n\n### Troubleshooting ###\nIf OpenSSL is installed in a non-default directory, pass `-DOPENSSL_ROOT_DIR=/path/to/openssl` to the cmake command for libmongocrypt.\n\nIf there are errors with cmake configuration, send the set of steps you performed to the maintainers of this project.\n\nIf there are compilation or linker errors, run `make` again, setting `VERBOSE=1` in the environment or on the command line (which shows exact compile and link commands), and send the output to the maintainers of this project.\n\n### Releasing ###\n\nSee [releasing](./doc/releasing.md).\n\n## Installing libmongocrypt From Distribution Packages ##\nDistribution packages (i.e., .deb/.rpm) are built and published for several Linux distributions.  The installation of these packages for supported platforms is documented here.\n\n### Unstable Development Distribution Packages ###\nTo install the latest unstable development package, change `1.17` to `development` in the package URLs listed in the subsequent instructions. For example, `https://libmongocrypt.s3.amazonaws.com/apt/ubuntu \u003crelease\u003e/libmongocrypt/1.17` in the instructions would become `https://libmongocrypt.s3.amazonaws.com/apt/ubuntu \u003crelease\u003e/libmongocrypt/development`. Do not use the unstable version of libmongocrypt in a production environment.\n\n### .deb Packages (Debian and Ubuntu) ###\n\nThe repository containing the Debian and Ubuntu .deb packages can be configured automatically, using extrepo, or manually. Once the repository is configured then the packages can be installed.\n\n#### Repository configuration with extrepo ####\n\nExtrepo is available on Debian 11 and newer, as well as Ubuntu 20.04 and newer.\n\nFirst, install the extrepo package:\n\n```\nsudo apt install extrepo\n```\n\nIf you would like to see the information about the repository, it can be viewed with the search command:\n\n```\nextrepo search libmongocrypt\n```\n\nIn order to enable the repository, execute this command:\n\n```\nsudo extrepo enable libmongocrypt\n```\n\nOnce the repository is configured, continue with package installation.\n\n#### Manual repository configuration ####\n\nFirst, import the public key used to sign the package repositories:\n\n```\nsudo sh -c 'curl -s --location https://pgp.mongodb.com/libmongocrypt.asc | gpg --dearmor \u003e/etc/apt/trusted.gpg.d/libmongocrypt.gpg'\n```\n\nSecond, create a list entry for the repository.  For Ubuntu systems (be sure to change `\u003crelease\u003e` to `xenial`, `bionic`, `focal`, or `jammy`, as appropriate to your system):\n\n```\necho \"deb https://libmongocrypt.s3.amazonaws.com/apt/ubuntu \u003crelease\u003e/libmongocrypt/1.17 universe\" | sudo tee /etc/apt/sources.list.d/libmongocrypt.list\n```\n\nFor Debian systems (be sure to change `\u003crelease\u003e` to `stretch`, `buster`, `bullseye`, or `bookworm` as appropriate to your system):\n\n```\necho \"deb https://libmongocrypt.s3.amazonaws.com/apt/debian \u003crelease\u003e/libmongocrypt/1.17 main\" | sudo tee /etc/apt/sources.list.d/libmongocrypt.list\n```\n\n#### Package installation ####\n\nFinally, update the package cache and install the libmongocrypt packages:\n\n```\nsudo apt-get update\nsudo apt-get install -y libmongocrypt-dev\n```\n\n### .rpm Packages (RedHat, Suse, and Amazon) ###\n\nRPMs are available for supported systems running on both x86_64 and AArch64 (also called ARM64) processors. The sections below use `x86_64` in the example repository URLs. Substituting `aarch64` in the place of `x86_64` will permit installation of libmongocrypt packages on systems running on AArch64 processors.\n\n#### RedHat Enterprise Linux ####\n\nCreate the file `/etc/yum.repos.d/libmongocrypt.repo` with contents:\n\n```\n[libmongocrypt]\nname=libmongocrypt repository\nbaseurl=https://libmongocrypt.s3.amazonaws.com/yum/redhat/$releasever/libmongocrypt/1.17/x86_64\ngpgcheck=1\nenabled=1\ngpgkey=https://pgp.mongodb.com/libmongocrypt.asc\n```\n\nThen install the libmongocrypt packages:\n\n```\nsudo yum install -y libmongocrypt\n```\n\n#### Amazon Linux 2023 ####\n\nCreate the file `/etc/yum.repos.d/libmongocrypt.repo` with contents:\n\n```\n[libmongocrypt]\nname=libmongocrypt repository\nbaseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2023/libmongocrypt/1.17/x86_64\ngpgcheck=1\nenabled=1\ngpgkey=https://pgp.mongodb.com/libmongocrypt.asc\n```\n\nThen install the libmongocrypt packages:\n\n```\nsudo yum install -y libmongocrypt\n```\n\n#### Amazon Linux 2 ####\n\nCreate the file `/etc/yum.repos.d/libmongocrypt.repo` with contents:\n\n```\n[libmongocrypt]\nname=libmongocrypt repository\nbaseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2/libmongocrypt/1.17/x86_64\ngpgcheck=1\nenabled=1\ngpgkey=https://pgp.mongodb.com/libmongocrypt.asc\n```\n\nThen install the libmongocrypt packages:\n\n```\nsudo yum install -y libmongocrypt\n```\n\n#### Amazon Linux ####\n\nCreate the file `/etc/yum.repos.d/libmongocrypt.repo` with contents:\n\n```\n[libmongocrypt]\nname=libmongocrypt repository\nbaseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2013.03/libmongocrypt/1.17/x86_64\ngpgcheck=1\nenabled=1\ngpgkey=https://pgp.mongodb.com/libmongocrypt.asc\n```\n\nThen install the libmongocrypt packages:\n\n```\nsudo yum install -y libmongocrypt\n```\n\n#### Suse ####\n\nFirst, import the public key used to sign the package repositories:\n\n```\nsudo rpm --import https://pgp.mongodb.com/libmongocrypt.asc\n```\n\nSecond, add the repository (be sure to change `\u003crelease\u003e` to `12` or `15`, as appropriate to your system):\n\n```\nsudo zypper addrepo --gpgcheck \"https://libmongocrypt.s3.amazonaws.com/zypper/suse/\u003crelease\u003e/libmongocrypt/1.17/x86_64\" libmongocrypt\n```\n\nFinally, install the libmongocrypt packages:\n\n```\nsudo zypper -n install libmongocrypt\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmongodb%2Flibmongocrypt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmongodb%2Flibmongocrypt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmongodb%2Flibmongocrypt/lists"}