Skip to content
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.

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

Invalid SPDX license identifier used in file #31938

Closed
kestewart opened this issue Feb 3, 2021 · 5 comments · Fixed by #32025
Closed

Invalid SPDX license identifier used in file #31938

kestewart opened this issue Feb 3, 2021 · 5 comments · Fixed by #32025
Assignees
Labels
area: Modules bug The issue is a bug, or the PR is fixing a bug Licensing The PR has licensing issues => licensing expert to review platform: nRF Nordic nRFx priority: high High impact/importance bug
Milestone

Comments

@kestewart
Copy link
Member

Describe the bug
An invalid SPDX license identifier is being specified in
https://github.com/zephyrproject-rtos/openthread/blob/zephyr/third_party/NordicSemiconductor/libraries/nrf_security/config/nrf-config.h

SPDX-License-Identifier: BSD-3-Clause OR Arm’s non-OSI source license

The phrase "Arm's non-OSI source license" is not a valid SPDX license identifier.

To Reproduce
The problem is in the source files, and needs to be addressed there.

Expected behavior
Valid SPDX license identifier from https://spdx.org/licenses/ should be used, or
a "LicenseRef-" identifier should be created and used. Details on the "LicenseRef-" syntax can be found in https://spdx.github.io/spdx-spec/6-other-licensing-information-detected/#61-license-identifier should be used in the expression

Impact
Serious - this breaks tooling working to summarize the licenses for the sources and generate SPDX documents.

Logs and console output

FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/config/nrf-config.h
SPDXID: SPDXRef-File-nrf-config.h
FileChecksum: SHA1: e667be982ab96d6d59de7b965538cb109d91d18c
FileChecksum: SHA256: fb5342294f7c89fba780af925abb41aecf583a1d692e73d05a8d0b2af581203c
LicenseConcluded: BSD-3-Clause OR Arm’s non-OSI source license
LicenseInfoInFile: Arm’s
LicenseInfoInFile: BSD-3-Clause
LicenseInfoInFile: license
LicenseInfoInFile: non-OSI
LicenseInfoInFile: source
FileCopyrightText: NOASSERTION

Environment (please complete the following information):
The problem can be seen in the source file.

Additional context
This same problem can also be seen in:
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/ccm_alt.h
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/chacha20_alt.h
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/chachapoly_alt.h
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/ecp_alt.h
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/platform_alt.h
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/poly1305_alt.h
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/sha1_alt.h
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/sha256_alt.h
FileName: ./modules/lib/openthread/third_party/NordicSemiconductor/libraries/nrf_security/include/mbedtls/threading_alt.h

@kestewart kestewart added bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug Licensing The PR has licensing issues => licensing expert to review area: Modules labels Feb 3, 2021
@kestewart kestewart added this to the v2.5.0 milestone Feb 3, 2021
@carlescufi carlescufi added the platform: nRF Nordic nRFx label Feb 3, 2021
@carlescufi
Copy link
Member

@kestewart what would be the correct way of expressing the dual-licensing using SPDX? To have 2 separate SPDX lines?

@kestewart
Copy link
Member Author

@carlescufi The way the license expression itself is written is fine. Problem is

The phrase "Arm's non-OSI source license" is not a valid SPDX license identifier.

See the link provided earlier for how to code up something that doesn't have an equivalent on
the SPDX license list.

Possibly Arm has a standard SPDX identifier they use for this license already ?

If not, suggest you follow the guidelines from https://reuse.software/spec/#license-files and create a License file in the module with the text of the license you want to represent, and then name it
something that conforms to the standard, like "LicenseRef-ARM-non-OSI-source".

Alternately - given that its an "OR" scenario, will your legal folk just let you release it with the BSD-3-Clause license and avoid the issue?

@swinslow
Copy link
Collaborator

swinslow commented Feb 3, 2021

From the SPDX community perspective, agreed with @kestewart -- LicenseRef-ARM-non-OSI-source would likely be fine as a custom identifier, and would be syntactically valid.

@carlescufi
Copy link
Member

The OpenThread PR has now been merged: openthread/openthread#6137
So we either update our OpenThread copy or cherry-pick this commit into our fork. I will let @rlubos decide as the module maintainer.

@edmont
Copy link
Collaborator

edmont commented Feb 5, 2021

@carlescufi, I proceeded with the upmerge: #32025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Modules bug The issue is a bug, or the PR is fixing a bug Licensing The PR has licensing issues => licensing expert to review platform: nRF Nordic nRFx priority: high High impact/importance bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants