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

Properly handle edge cases in AN10922 key diversification #118

Merged
merged 1 commit into from
Oct 29, 2019

Conversation

darconeous
Copy link
Member

@darconeous darconeous commented Oct 29, 2019

This commit fixes issue #91.

AN10922 specifies the key diversification algorithms used by the MIFARE SAM AV3. Support for these algorithms was added to libfreefare via pull-request #79.

However, while every attempt was made to write a faithful implementation, the implemented code did not properly handle cases where the diversification data was less than or equal to the block size of the cipher: 16 bytes for AES, and 8 bytes for DES. This bug was identified in issue #91.

This commit addresses this problem while providing a way to revert to the previous behavior in cases where it is necessary to maintain previous deployments. This was accomplished by introducing a new flags parameter to the mifare_key_deriver_new_an10922 method.

Normally, flags should simply be set to AN10922_FLAG_DEFAULT. However, if the previous behavior is required, it should be set to AN10922_FLAG_EMULATE_ISSUE_91.

AN10922 does not include any test vectors that might have helped to identify this problem earlier. However, AN10957 (pages 13-14) was found to have a suitable example usage of AN10922 with an appropriately short value for M that we are using as a test vector to verify correct behavior.

Note that the issue being addressed here is not a security issue: using the AN10922_FLAG_EMULATE_ISSUE_91 should not be any less secure than using AN10922_FLAG_DEFAULT.

Copy link
Contributor

@smortex smortex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This look great. I added inline comments for a few minor things.

libfreefare/freefare.h Show resolved Hide resolved
libfreefare/mifare_key_deriver.c Outdated Show resolved Hide resolved
This commit fixes issue nfc-tools#91.

[AN10922][] specifies the key diversification algorithms used by the
MIFARE SAM AV3. Support for these algorithms was added to
`libfreefare` via pull-request nfc-tools#79.

However, while every attempt was made to write a faithful
implementation, the implemented code did not properly handle cases
where the diversification data was less than or equal to the block
size of the cipher: 16 bytes for AES, and 8 bytes for DES. This
bug was identified in issue nfc-tools#91.

This commit addresses this problem while providing a way to revert to
the previous behavior in cases where it is necessary to maintain
previous deployments. This was accomplished by introducing a new
`flags` parameter to the `mifare_key_deriver_new_an10922` method.

Normally, `flags` should simply be set to `AN10922_FLAG_DEFAULT`.
However, if the previous behavior is required, it should be set to
`AN10922_FLAG_EMULATE_ISSUE_91`.

[AN10922][] does not include any test vectors that might have helped to
identify this problem earlier. However, [AN10957][] (pages 13-14) was
found to have a suitable example usage of [AN10922][] with an
appropriately short value for *M* that we are using as a test vector
to verify correct behavior.

Note that the issue being addressed here is not a security issue:
using the `AN10922_FLAG_EMULATE_ISSUE_91` should not be any less
secure than using `AN10922_FLAG_DEFAULT`.

[AN10922]: https://www.nxp.com/docs/en/application-note/AN10922.pdf
[AN10957]: https://www.nxp.com/docs/en/application-note/AN10957.pdf
Copy link
Contributor

@smortex smortex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Let's confirm you can merge this approved PR!

@darconeous darconeous merged commit b83cbcb into nfc-tools:master Oct 29, 2019
@darconeous darconeous deleted the issue-91 branch October 29, 2019 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants