Skip to content

Add licensing check for Rust code #6416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emesare merged 1 commit into from
Feb 13, 2025
Merged

Add licensing check for Rust code #6416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion .github/workflows/rust.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,22 @@ jobs:
- name: Typo Check
uses: crate-ci/typos@v1.29.4
with:
files: ./rust
files: ./rust

# Check licensing and produce a list of licenses
licensing:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install cargo-about
uses: baptiste0928/cargo-install@v3
with:
crate: cargo-about
version: "0.6.6"
- name: Run license check
run: cargo about generate about.hbs > license.html
- name: Archive license file
uses: actions/upload-artifact@v4
with:
name: license
path: license.html
70 changes: 70 additions & 0 deletions about.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<html>

<head>
<style>
@media (prefers-color-scheme: dark) {
body {
background: #333;
color: white;
}
a {
color: skyblue;
}
}
.container {
font-family: sans-serif;
max-width: 800px;
margin: 0 auto;
}
.intro {
text-align: center;
}
.licenses-list {
list-style-type: none;
margin: 0;
padding: 0;
}
.license-used-by {
margin-top: -10px;
}
.license-text {
max-height: 200px;
overflow-y: scroll;
white-space: pre-wrap;
}
</style>
</head>

<body>
<main class="container">
<div class="intro">
<h1>Third Party Licenses</h1>
<p>This page lists the licenses of the **rust** projects used in binaryninja-api.</p>
</div>

<h2>Overview of licenses:</h2>
<ul class="licenses-overview">
{{#each overview}}
<li><a href="#{{id}}">{{name}}</a> ({{count}})</li>
{{/each}}
</ul>

<h2>All license text:</h2>
<ul class="licenses-list">
{{#each licenses}}
<li class="license">
<h3 id="{{id}}">{{name}}</h3>
<h4>Used by:</h4>
<ul class="license-used-by">
{{#each used_by}}
<li><a href="{{#if crate.repository}} {{crate.repository}} {{else}} https://crates.io/crates/{{crate.name}} {{/if}}">{{crate.name}} {{crate.version}}</a></li>
{{/each}}
</ul>
<pre class="license-text">{{text}}</pre>
</li>
{{/each}}
</ul>
</main>
</body>

</html>
10 changes: 10 additions & 0 deletions about.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
accepted = [
"Apache-2.0",
"MIT",
"Unicode-DFS-2016",
"Unicode-3.0",
"ISC",
"BSD-3-Clause",
"BSL-1.0",
"LicenseRef-scancode-google-patent-license-fuchsia"
]
1 change: 1 addition & 0 deletions arch/msp430/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "arch_msp430"
version = "0.1.0"
authors = ["jrozner"]
edition = "2021"
license = "Apache-2.0"

[dependencies]
binaryninja.workspace = true
Expand Down
1 change: 1 addition & 0 deletions arch/riscv/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "arch_riscv"
version = "0.1.0"
authors = ["Ryan Snyder <ryan.snyder.or@gmail.com>"]
edition = "2021"
license = "Apache-2.0"

[dependencies]
binaryninja.workspace = true
Expand Down
1 change: 1 addition & 0 deletions arch/riscv/disasm/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "riscv-dis"
version = "0.1.0"
authors = ["Ryan Snyder <ryan.snyder.or@gmail.com>"]
edition = "2021"
license = "Apache-2.0"

[dependencies]
byteorder = "1"
1 change: 1 addition & 0 deletions plugins/dwarf/dwarf_export/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name = "dwarf_export"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"

[lib]
crate-type = ["cdylib"]
Expand Down
1 change: 1 addition & 0 deletions plugins/dwarf/dwarf_import/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name = "dwarf_import"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"

[lib]
crate-type = ["cdylib"]
Expand Down
1 change: 1 addition & 0 deletions plugins/dwarf/dwarfdump/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "dwarfdump"
version = "0.1.0"
authors = ["Kyle Martin <kyle@vector35.com>"]
edition = "2021"
license = "Apache-2.0"

[lib]
crate-type = ["cdylib"]
Expand Down
1 change: 1 addition & 0 deletions plugins/dwarf/shared/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "dwarfreader"
version = "0.1.0"
authors = ["Kyle Martin <kyle@vector35.com>"]
edition = "2021"
license = "Apache-2.0"

[dependencies]
binaryninja.workspace = true
Expand Down
1 change: 1 addition & 0 deletions plugins/idb_import/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "idb_import"
version = "0.1.0"
authors = ["Rubens Brandao <git@rubens.io>"]
edition = "2021"
license = "Apache-2.0"

[lib]
crate-type = ["cdylib"]
Expand Down
1 change: 1 addition & 0 deletions plugins/pdb-ng/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name = "pdb-import-plugin"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"

[lib]
crate-type = ["cdylib"]
Expand Down
1 change: 1 addition & 0 deletions plugins/pdb-ng/demo/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name = "pdb-import-plugin-static"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"

[lib]
crate-type = ["staticlib"]
Expand Down
1 change: 1 addition & 0 deletions plugins/warp/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name = "warp_ninja"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"

[lib]
crate-type = ["lib", "cdylib"]
Expand Down
1 change: 1 addition & 0 deletions rust/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ version = "0.1.0"
authors = ["Ryan Snyder <ryan@vector35.com>", "Kyle Martin <kyle@vector35.com>"]
edition = "2021"
rust-version = "1.83.0"
license = "Apache-2.0"

[features]
# This is used when statically linking to prevent exporting CorePluginABIVersion and UiPluginABIVersion.
Expand Down
1 change: 1 addition & 0 deletions rust/binaryninjacore-sys/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors = ["Ryan Snyder <ryan@vector35.com>", "Kyle Martin <kyle@vector35.com>"]
build = "build.rs"
edition = "2021"
links = "binaryninjacore"
license = "Apache-2.0"

[build-dependencies]
bindgen = "0.71.1"
Expand Down
1 change: 1 addition & 0 deletions view/minidump/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name = "minidump_bn"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"

[lib]
crate-type = ["cdylib"]
Expand Down
Loading