Skip to content

Conversation

LMESTM
Copy link
Contributor

@LMESTM LMESTM commented Sep 22, 2017

Description

HAL_RNG_GetRandomNumber is a deprecated API and replaced here with a call to HAL_RNG_GenerateRandomNumber. Doing so, we also rework the driver to use the 4 bytes returned by a call to HAL_RNG_GenerateRandomNumber instead of 1 byte out of 4.
HAL_RNG_GenerateRandomNumber was not returning any error code, so now we can also check the return code.

A second commit ensures that there is a single user at a time.

Status

READY

Tests

+-----------------------+---------------+------------------------+--------+--------------------+-------------+
| target                | platform_name | test suite             | result | elapsed_time (sec) | copy_method |
+-----------------------+---------------+------------------------+--------+--------------------+-------------+
| NUCLEO_F091RC-ARM     | NUCLEO_F091RC | tests-mbedtls-selftest | OK     | 212.18             | default     |
| NUCLEO_F091RC-GCC_ARM | NUCLEO_F091RC | tests-mbedtls-selftest | OK     | 218.93             | default     |
| NUCLEO_F091RC-IAR     | NUCLEO_F091RC | tests-mbedtls-selftest | OK     | 257.7              | default     |
| NUCLEO_F103RB-ARM     | NUCLEO_F103RB | tests-mbedtls-selftest | OK     | 205.53             | default     |
| NUCLEO_F103RB-GCC_ARM | NUCLEO_F103RB | tests-mbedtls-selftest | OK     | 218.34             | default     |
| NUCLEO_F103RB-IAR     | NUCLEO_F103RB | tests-mbedtls-selftest | OK     | 209.21             | default     |
| NUCLEO_F207ZG-ARM     | NUCLEO_F207ZG | tests-mbedtls-selftest | OK     | 203.52             | default     |
| NUCLEO_F207ZG-GCC_ARM | NUCLEO_F207ZG | tests-mbedtls-selftest | OK     | 276.4              | default     |
| NUCLEO_F207ZG-IAR     | NUCLEO_F207ZG | tests-mbedtls-selftest | OK     | 200.14             | default     |
| NUCLEO_F303ZE-ARM     | NUCLEO_F303ZE | tests-mbedtls-selftest | OK     | 251.18             | default     |
| NUCLEO_F303ZE-GCC_ARM | NUCLEO_F303ZE | tests-mbedtls-selftest | OK     | 206.28             | default     |
| NUCLEO_F303ZE-IAR     | NUCLEO_F303ZE | tests-mbedtls-selftest | OK     | 202.71             | default     |
| NUCLEO_F446RE-ARM     | NUCLEO_F446RE | tests-mbedtls-selftest | OK     | 200.99             | default     |
| NUCLEO_F446RE-GCC_ARM | NUCLEO_F446RE | tests-mbedtls-selftest | OK     | 279.02             | default     |
| NUCLEO_F446RE-IAR     | NUCLEO_F446RE | tests-mbedtls-selftest | OK     | 197.36             | default     |
| NUCLEO_F767ZI-ARM     | NUCLEO_F767ZI | tests-mbedtls-selftest | OK     | 197.78             | default     |
| NUCLEO_F767ZI-GCC_ARM | NUCLEO_F767ZI | tests-mbedtls-selftest | OK     | 198.37             | default     |
| NUCLEO_F767ZI-IAR     | NUCLEO_F767ZI | tests-mbedtls-selftest | OK     | 201.52             | default     |
| NUCLEO_L073RZ-ARM     | NUCLEO_L073RZ | tests-mbedtls-selftest | OK     | 217.76             | default     |
| NUCLEO_L073RZ-GCC_ARM | NUCLEO_L073RZ | tests-mbedtls-selftest | OK     | 222.04             | default     |
| NUCLEO_L073RZ-IAR     | NUCLEO_L073RZ | tests-mbedtls-selftest | OK     | 253.9              | default     |
| NUCLEO_L152RE-ARM     | NUCLEO_L152RE | tests-mbedtls-selftest | OK     | 207.84             | default     |
| NUCLEO_L152RE-GCC_ARM | NUCLEO_L152RE | tests-mbedtls-selftest | OK     | 212.86             | default     |
| NUCLEO_L152RE-IAR     | NUCLEO_L152RE | tests-mbedtls-selftest | OK     | 210.24             | default     |
| NUCLEO_L476RG-ARM     | NUCLEO_L476RG | tests-mbedtls-selftest | OK     | 210.63             | default     |
| NUCLEO_L476RG-GCC_ARM | NUCLEO_L476RG | tests-mbedtls-selftest | OK     | 205.5              | default     |
| NUCLEO_L476RG-IAR     | NUCLEO_L476RG | tests-mbedtls-selftest | OK     | 203.64             | default     |
+-----------------------+---------------+------------------------+--------+--------------------+-------------+
mbedgt: test suite results: 27 OK
  • All boards compiled OK, for which same tests is ongoing

@LMESTM LMESTM force-pushed the trng_deprecated_call branch from 6deaa96 to 73d9da1 Compare September 25, 2017 07:26
@LMESTM
Copy link
Contributor Author

LMESTM commented Sep 25, 2017

@adustm

@adustm
Copy link
Member

adustm commented Sep 25, 2017

LGTM

Copy link
Contributor

Choose a reason for hiding this comment

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

line 36 - uses atomic access, not here when you are setting it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In the free case, I don't have to test the value, I just have to set it to unused, so I preferred to keep it simple: as there is only 1 user, once freed, it will always be 0.

An alternative is to throw an error in case of unbalanced, (like in sleep manager):

core_util_critical_section_enter();
if (users == 0) {
    core_util_critical_section_exit();
    error("Unbalanced number of trng free (< 0)");
}
core_util_atomic_decr_u16(&users, 1);
core_util_critical_section_exit();

but that seemed overkill to me ...
I can do the change anyway if people think it's of added value.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK, can be as it is.

Why init can be called only once - one owner limitation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes - one HW only and only one client in MBED in features/mbedtls/platform/src/mbed_trng.c, so I'll stick to it for now.

@0xc0170
Copy link
Contributor

0xc0170 commented Sep 26, 2017

cc @yanesca @andresag01 @RonEld

@ciarmcom
Copy link
Member

ARM Internal Ref: IOTSSL-1790

@0xc0170
Copy link
Contributor

0xc0170 commented Oct 10, 2017

bump for review

@adustm
Copy link
Member

adustm commented Oct 10, 2017

Hello @0xc0170
The review is fine from my side, as I worked internally with @LMESTM on this PR.
I guess you meant @yanesca @RonEld or @andresag01 ?

Kind regards
Armelle

Copy link
Contributor

@RonEld RonEld left a comment

Choose a reason for hiding this comment

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

I left one comment about a corner case where a buffer overflow could happen

Copy link
Contributor

Choose a reason for hiding this comment

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

what about corner cases where output length will not be a multiple of 4? In this case you will overflow the buffer

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought I'd covered it, but clearly missed here - will fix - thx Ron !

@LMESTM LMESTM force-pushed the trng_deprecated_call branch from b0854a3 to 91c6b42 Compare October 10, 2017 16:10
@LMESTM
Copy link
Contributor Author

LMESTM commented Oct 10, 2017

@RonEld thanks for review - I pushed an update to the code which should address the issue

Copy link
Contributor

@RonEld RonEld left a comment

Choose a reason for hiding this comment

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

Thank you @LMESTM for the changes.
Looks good to me

@LMESTM
Copy link
Contributor Author

LMESTM commented Oct 11, 2017

thanks again @RonEld
Latest version retested ok

+-------------------+---------------+------------------------+--------+--------------------+-------------+
| target            | platform_name | test suite             | result | elapsed_time (sec) | copy_method |
+-------------------+---------------+------------------------+--------+--------------------+-------------+
| NUCLEO_F091RC-ARM | NUCLEO_F091RC | tests-mbedtls-selftest | OK     | 211.91             | default     |
| NUCLEO_F103RB-ARM | NUCLEO_F103RB | tests-mbedtls-selftest | OK     | 206.03             | default     |
| NUCLEO_F207ZG-ARM | NUCLEO_F207ZG | tests-mbedtls-selftest | OK     | 199.76             | default     |
| NUCLEO_F303ZE-ARM | NUCLEO_F303ZE | tests-mbedtls-selftest | OK     | 205.64             | default     |
| NUCLEO_F446RE-ARM | NUCLEO_F446RE | tests-mbedtls-selftest | OK     | 202.14             | default     |
| NUCLEO_F767ZI-ARM | NUCLEO_F767ZI | tests-mbedtls-selftest | OK     | 200.69             | default     |
| NUCLEO_L073RZ-ARM | NUCLEO_L073RZ | tests-mbedtls-selftest | OK     | 222.38             | default     |
| NUCLEO_L152RE-ARM | NUCLEO_L152RE | tests-mbedtls-selftest | OK     | 210.55             | default     |
| NUCLEO_L476RG-ARM | NUCLEO_L476RG | tests-mbedtls-selftest | OK     | 209.27             | default     |
+-------------------+---------------+------------------------+--------+--------------------+-------------+

@0xc0170
Copy link
Contributor

0xc0170 commented Oct 11, 2017

@yanesca Waiting for your input here? or @RonEld review suffiecient

@yanesca
Copy link
Contributor

yanesca commented Oct 11, 2017

@0xc0170 Could you please wait for my input? I'll have a look at it quickly.

Copy link
Contributor

@yanesca yanesca left a comment

Choose a reason for hiding this comment

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

It looks good in general, I just have a minor request and a question.

Copy link
Contributor

Choose a reason for hiding this comment

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

What happens if we call HAL_RNG_GenerateRandomNumber() without calling trng_init() first?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

HAL would return an error in such case.

Copy link
Contributor

Choose a reason for hiding this comment

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

I know that I am being paranoid, but could we please wipe the random[] buffer before returning.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure - will do so and post an update

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok I made an update and now random is erased immediately after use.

@mbed-ci
Copy link

mbed-ci commented Oct 11, 2017

Build : SUCCESS

Build number : 119
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/5179/

Triggering tests

/test mbed-os

@mbed-ci
Copy link

mbed-ci commented Oct 12, 2017

@mbed-ci
Copy link

mbed-ci commented Oct 12, 2017

Build : SUCCESS

Build number : 157
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/5179/

Triggering tests

/test mbed-os

Copy link
Contributor

Choose a reason for hiding this comment

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

I suspect this way most of the compilers would optimise the out the instructions zeroising the array, declaring random[] to be volatile might be necessary to prevent it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yet another good point - thanks !
done

HAL_RNG_GetRandomNumber is a deprecated API and replaced here with
a call to HAL_RNG_GenerateRandomNumber.

Doing so, we also rework the driver to use the 4 bytes returned by a call
to HAL_RNG_GenerateRandomNumber instead of 1 byte out of 4.

HAL_RNG_GenerateRandomNumber was not returning any error code, so now
we can also check the return code.
There is only 1 RNG HW IP and we do not support more than one driver
user at a time, so let's ensure this is the case and raise an error if
needed.
@LMESTM LMESTM force-pushed the trng_deprecated_call branch from 8251ff4 to 849749f Compare October 13, 2017 15:03
@0xc0170
Copy link
Contributor

0xc0170 commented Oct 19, 2017

/morph build

@studavekar
Copy link
Contributor

/morph build

@mbed-ci
Copy link

mbed-ci commented Oct 20, 2017

Build : SUCCESS

Build number : 289
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/5179/

Triggering tests

/morph test
/morph uvisor-test

@mbed-ci
Copy link

mbed-ci commented Oct 20, 2017

Build : SUCCESS

Build number : 292
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/5179/

Triggering tests

/morph test
/morph uvisor-test

@mbed-ci
Copy link

mbed-ci commented Oct 20, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants