Proposal: rename tpm1_eventlog.c and tpm2_eventlog.c

Proposal: rename tpm1_eventlog.c and tpm2_eventlog.c

[Jarkko Sakkinen]

I noticed when making slides for KS that the naming for event log stuff
that the naming is so broken that it is hard to understand the code.
Here it really would make sense to have a patch set just to clean up the
cruft.

Random examples of more senseful naming:

* tpm2_bios_measurements_start() should be rather something like
  tpm_eventlog_seq_agile_start().
* tpm_bios_measurements_start() should be rather something like
  tpm_eventlog_seq_sha1_start().

Corresponding structs would be tpm_eventlog_agile_seq_ops and
tpm_eventlog_sha1_seq_ops.

Finally, I would place the file operations, being so complicated, in
separate files:

* tpm_eventlog_seq_sha1.c
* tpm_eventlog_seq_eventlog.c

And move all the management code that is right now illogically located
in tpm1_eventlog.c to tpm_eventlog.c that would be the entry point for
the event log.

The code is laid out so badly right now that I have really hard time
understanding it if I haven't looked at it within last couple of weeks.
It's really a trainwreck at the moment. We must clean up it up fast.

Getting this done will help me to review patches to this area faster
so it would be a benefit for everyone. The current structure makes every
event log patch a pain to review.

/Jarkko
--
To unsubscribe from this list: send the line "unsubscribe linux-security-module" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Proposal: rename tpm1_eventlog.c and tpm2_eventlog.c

[Thiebaud Weksteen]

On Wed, Oct 25, 2017 at 12:21 AM, Jarkko Sakkinen
<jarkko.sakkinen@linux.intel.com> wrote:
> I noticed when making slides for KS that the naming for event log stuff
> that the naming is so broken that it is hard to understand the code.
> Here it really would make sense to have a patch set just to clean up the
> cruft.

Agreed and happy to help.

>
> Random examples of more senseful naming:
>
> * tpm2_bios_measurements_start() should be rather something like
>   tpm_eventlog_seq_agile_start().
> * tpm_bios_measurements_start() should be rather something like
>   tpm_eventlog_seq_sha1_start().
>
> Corresponding structs would be tpm_eventlog_agile_seq_ops and
> tpm_eventlog_sha1_seq_ops.
>
> Finally, I would place the file operations, being so complicated, in
> separate files:
>
> * tpm_eventlog_seq_sha1.c
> * tpm_eventlog_seq_eventlog.c

I assume you meant tpm_eventlog_seq_agile.c ?

>
> And move all the management code that is right now illogically located
> in tpm1_eventlog.c to tpm_eventlog.c that would be the entry point for
> the event log.
>
> The code is laid out so badly right now that I have really hard time
> understanding it if I haven't looked at it within last couple of weeks.
> It's really a trainwreck at the moment. We must clean up it up fast.
>
> Getting this done will help me to review patches to this area faster
> so it would be a benefit for everyone. The current structure makes every
> event log patch a pain to review.

Since this may conflict with the last patch set I sent, are you happy
for me to base this new set on tpmdd/master?

>
> /Jarkko
--
To unsubscribe from this list: send the line "unsubscribe linux-security-module" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Proposal: rename tpm1_eventlog.c and tpm2_eventlog.c

[Jarkko Sakkinen]

On Wed, Oct 25, 2017 at 10:43:10AM +0200, Thiebaud Weksteen wrote:
> On Wed, Oct 25, 2017 at 12:21 AM, Jarkko Sakkinen
> <jarkko.sakkinen@linux.intel.com> wrote:
> > I noticed when making slides for KS that the naming for event log stuff
> > that the naming is so broken that it is hard to understand the code.
> > Here it really would make sense to have a patch set just to clean up the
> > cruft.
> 
> Agreed and happy to help.

That would be great! Thank you.

> > Random examples of more senseful naming:
> >
> > * tpm2_bios_measurements_start() should be rather something like
> >   tpm_eventlog_seq_agile_start().
> > * tpm_bios_measurements_start() should be rather something like
> >   tpm_eventlog_seq_sha1_start().
> >
> > Corresponding structs would be tpm_eventlog_agile_seq_ops and
> > tpm_eventlog_sha1_seq_ops.
> >
> > Finally, I would place the file operations, being so complicated, in
> > separate files:
> >
> > * tpm_eventlog_seq_sha1.c
> > * tpm_eventlog_seq_eventlog.c
> 
> I assume you meant tpm_eventlog_seq_agile.c ?

Yes.

> >
> > And move all the management code that is right now illogically located
> > in tpm1_eventlog.c to tpm_eventlog.c that would be the entry point for
> > the event log.
> >
> > The code is laid out so badly right now that I have really hard time
> > understanding it if I haven't looked at it within last couple of weeks.
> > It's really a trainwreck at the moment. We must clean up it up fast.
> >
> > Getting this done will help me to review patches to this area faster
> > so it would be a benefit for everyone. The current structure makes every
> > event log patch a pain to review.
> 
> Since this may conflict with the last patch set I sent, are you happy
> for me to base this new set on tpmdd/master?

What about this: you do an updated version of your patch set that
includes these clean ups?

PS. Sorry for slowness with your patches. I've just had a lot of stuff
going on lately. They are 2nd in my priority queue right after
CVE-2017-15361.

/Jarkko
--
To unsubscribe from this list: send the line "unsubscribe linux-security-module" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Proposal: rename tpm1_eventlog.c and tpm2_eventlog.c

[Jarkko Sakkinen]

On Wed, Oct 25, 2017 at 03:18:48PM +0200, Jarkko Sakkinen wrote:
> > Since this may conflict with the last patch set I sent, are you happy
> > for me to base this new set on tpmdd/master?
> 
> What about this: you do an updated version of your patch set that
> includes these clean ups?
> 
> PS. Sorry for slowness with your patches. I've just had a lot of stuff
> going on lately. They are 2nd in my priority queue right after
> CVE-2017-15361.

This is an awful idea as your patch is in great shape and we want to
land that feature ASAP. Lets land your patches first and then plan how
to do the clean up.

I have some other suggestions for the clean up work that require even
more work. Mainly: I think it would make sense to have an eventlog
subdirectory for the eventlog as it's growing so complex.

What do you think?

/Jarkko
--
To unsubscribe from this list: send the line "unsubscribe linux-security-module" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Proposal: rename tpm1_eventlog.c and tpm2_eventlog.c

[Thiebaud Weksteen]

On Thu, Oct 26, 2017 at 4:14 PM, Jarkko Sakkinen
<jarkko.sakkinen@linux.intel.com> wrote:
> On Wed, Oct 25, 2017 at 03:18:48PM +0200, Jarkko Sakkinen wrote:
>> > Since this may conflict with the last patch set I sent, are you happy
>> > for me to base this new set on tpmdd/master?
>>
>> What about this: you do an updated version of your patch set that
>> includes these clean ups?
>>
>> PS. Sorry for slowness with your patches. I've just had a lot of stuff
>> going on lately. They are 2nd in my priority queue right after
>> CVE-2017-15361.
>
> This is an awful idea as your patch is in great shape and we want to
> land that feature ASAP. Lets land your patches first and then plan how
> to do the clean up.
>
> I have some other suggestions for the clean up work that require even
> more work. Mainly: I think it would make sense to have an eventlog
> subdirectory for the eventlog as it's growing so complex.
>
> What do you think?

Yes, I would prefer this option as well. Also, agreed on a subdirectory.

>
> /Jarkko
--
To unsubscribe from this list: send the line "unsubscribe linux-security-module" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Proposal: rename tpm1_eventlog.c and tpm2_eventlog.c

[Nayna Jain]

On 10/25/2017 03:51 AM, Jarkko Sakkinen wrote:
> I noticed when making slides for KS that the naming for event log stuff
> that the naming is so broken that it is hard to understand the code.
> Here it really would make sense to have a patch set just to clean up the
> cruft.
>
> Random examples of more senseful naming:
>
> * tpm2_bios_measurements_start() should be rather something like
>    tpm_eventlog_seq_agile_start().
> * tpm_bios_measurements_start() should be rather something like
>    tpm_eventlog_seq_sha1_start().
BIOS eventlog being exposed as securityfs files are named as
ascii_bios_measurements and binary_bios_measurements.
I thought that the function names were originally written corresponding
to the files they write into. In that context, I didn't find them 
misleading.

Still if we want to rename, I think having tpm_eventlog_seq_sha1_start() for
TPM1.2 might be confusing as even TPM2.0 supports SHA1. And there might
be systems which use only SHA1 even in the case of TPM2.0. I was 
thinking if
we can just call them as tpm2_eventlog_seq_start() and 
tpm1_eventlog_seq_start().
> Corresponding structs would be tpm_eventlog_agile_seq_ops and
> tpm_eventlog_sha1_seq_ops.
>
> Finally, I would place the file operations, being so complicated, in
> separate files:
>
> * tpm_eventlog_seq_sha1.c
> * tpm_eventlog_seq_eventlog.c
>
> And move all the management code that is right now illogically located
> in tpm1_eventlog.c to tpm_eventlog.c that would be the entry point for
> the event log.
By management code, do you mean the functions common to both TPM1.2 and 
TPM2.0 as:

tpm_bios_measurements_open()
tpm_read_log()
tpm_bios_log_setup()
tpm_bios_log_teardown()

So, do you mean to move these to tpm_eventlog.c and keep only specific 
functions in
tpm1_eventlog.c and tpm2_eventlog.c ? If so, then yeah I also agree with 
this.

Thanks & Regards,
 ?? - Nayna
> The code is laid out so badly right now that I have really hard time
> understanding it if I haven't looked at it within last couple of weeks.
> It's really a trainwreck at the moment. We must clean up it up fast.
>
> Getting this done will help me to review patches to this area faster
> so it would be a benefit for everyone. The current structure makes every
> event log patch a pain to review.
>
> /Jarkko
>

--
To unsubscribe from this list: send the line "unsubscribe linux-security-module" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html