Skip to content

Commit b1694df

Browse files
committed
Updated README file
1 parent 9186414 commit b1694df

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

cpp/lib/crypto/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,18 @@
33
This directory contains CodeQL base types targeted at C and C++
44
cryptographic implementations. The code is organized as follows:
55

6-
- `common`: Common, abstract base types used for general queries. These are collected
7-
in the QL library `common.qll`.
8-
- `libraries`: Library specific implementations of abstract base types
9-
defined under `common`. The library currently contains concrete
10-
implementations for parts of the `OpenSSL` and `mbedtls` libraries. Each
11-
library exposes a `<LIBRARY NAME>.qll` library which can be
12-
imported to target that specific library. When targeting all libraries,
13-
import `libraries.qll`.
6+
- `common`: Common, abstract base types used for general queries. These are
7+
collected in the QL library `common.qll`.
8+
- `openssl`: OpenSSL specific implementations of abstract base types
9+
defined under `common`. These are exposed by importing `openssl.qll`.
10+
- `mbedtls`: Mbedtls specific implementations of abstract base types
11+
defined under `common`. These are exposed by importing `mbedtls.qll`.
1412

1513
A goal of this project is to attempt to define reusable, abstract base types
1614
with enough expressive power to describe many common cryptographic
17-
vulnerabilities across many different implementations. This is still very much
15+
vulnerabilities across different implementations. This is still very much
1816
a work in progress which means that the structure and definitions of these
1917
types will most likely change over time.
18+
19+
This repository contains a number of queries built on top of the primitives
20+
defined here. These can be found under [`cpp/src/crypto`](../../src/crypto).

0 commit comments

Comments
 (0)