Linux IMA documentation

Linux IMA documentation

[Ken Goldman]

Is this the right place to announce this?  If not, let me know.

https://ima-doc.readthedocs.io/en/latest/index.html

This is a first pass at IMA documentation.  It's targeted at users, not 
kernel developers.

Some areas are clearly incomplete, but I don't think there is anything 
incorrect.

Suggestions, contributions, corrections are all welcome.

The source is at https://github.com/IBM/ima-doc

Re: Linux IMA documentation

[Jarkko Sakkinen]

On Wed Aug 16, 2023 at 9:42 PM UTC, Ken Goldman wrote:
> Is this the right place to announce this?  If not, let me know.
>
> https://ima-doc.readthedocs.io/en/latest/index.html
>
> This is a first pass at IMA documentation.  It's targeted at users, not 
> kernel developers.
>
> Some areas are clearly incomplete, but I don't think there is anything 
> incorrect.
>
> Suggestions, contributions, corrections are all welcome.
>
> The source is at https://github.com/IBM/ima-doc

Looks useful for non-IMA kernel developers too IMHO, thanks for doing
this.

BR, Jarkko

Re: Linux IMA documentation

[Ken Goldman]

Thank you.

Do you know the process for getting this accepted into the kernel 
documentation.

It's not ready today, but I should start on the process/

On 8/17/2023 12:04 PM, Jarkko Sakkinen wrote:
> On Wed Aug 16, 2023 at 9:42 PM UTC, Ken Goldman wrote:
>> Is this the right place to announce this?  If not, let me know.
>>
>> https://ima-doc.readthedocs.io/en/latest/index.html
>>
>> This is a first pass at IMA documentation.  It's targeted at users, not
>> kernel developers.
>>
>> Some areas are clearly incomplete, but I don't think there is anything
>> incorrect.
>>
>> Suggestions, contributions, corrections are all welcome.
>>
>> The source is at https://github.com/IBM/ima-doc
> 
> Looks useful for non-IMA kernel developers too IMHO, thanks for doing
> this.
> 
> BR, Jarkko

Re: Linux IMA documentation

[Jarkko Sakkinen]

On Fri Sep 1, 2023 at 12:46 AM EEST, Ken Goldman wrote:
> Thank you.
>
> Do you know the process for getting this accepted into the kernel 
> documentation.

The bulk of the work would be to convert it ReStructured Text and
follow the guidelines in https://docs.kernel.org/doc-guide/index.html

You should also CC the documentation patches to:

* Jonathan Corbet <corbet@lwn.net> (maintainer of the documentation)
* linux-doc@vger.kernel.org
 
Perhaps Mimi could help out formalizing this together so I suggest to
work with her. I'm also happy to review the documentation once the
patches are out.

BR, Jarkko

Re: Linux IMA documentation

[Ken Goldman]

Jonathan:  What should be my next step?

On 9/4/2023 5:52 PM, Jarkko Sakkinen wrote:
> On Fri Sep 1, 2023 at 12:46 AM EEST, Ken Goldman wrote:
>> Thank you.
>>
>> Do you know the process for getting this accepted into the kernel
>> documentation.
> 
> The bulk of the work would be to convert it ReStructured Text and
> follow the guidelines in https://docs.kernel.org/doc-guide/index.html

I think I did that.  The source .rst is at
https://github.com/IBM/ima-doc

> 
> You should also CC the documentation patches to:
> 
> * Jonathan Corbet <corbet@lwn.net> (maintainer of the documentation)
> * linux-doc@vger.kernel.org

Thank you for this.

>   
> Perhaps Mimi could help out formalizing this together so I suggest to
> work with her. I'm also happy to review the documentation once the
> patches are out.

Mimi worked with me from the beginning.

Re: Linux IMA documentation

[Roberto Sassu]

On Wed, 2023-09-06 at 16:54 -0400, Ken Goldman wrote:
> Jonathan:  What should be my next step?
> 
> On 9/4/2023 5:52 PM, Jarkko Sakkinen wrote:
> > On Fri Sep 1, 2023 at 12:46 AM EEST, Ken Goldman wrote:
> > > Thank you.
> > > 
> > > Do you know the process for getting this accepted into the kernel
> > > documentation.
> > 
> > The bulk of the work would be to convert it ReStructured Text and
> > follow the guidelines in https://docs.kernel.org/doc-guide/index.html
> 
> I think I did that.  The source .rst is at
> https://github.com/IBM/ima-doc

I think your document is a good candidate for being put in
Documentation/admin-guide/LSM/, once my patch set is upstreamed:

https://lore.kernel.org/linux-integrity/20230904133415.1799503-1-roberto.sassu@huaweicloud.com/

Thanks

Roberto

> > 
> > You should also CC the documentation patches to:
> > 
> > * Jonathan Corbet <corbet@lwn.net> (maintainer of the documentation)
> > * linux-doc@vger.kernel.org
> 
> Thank you for this.
> 
> >   
> > Perhaps Mimi could help out formalizing this together so I suggest to
> > work with her. I'm also happy to review the documentation once the
> > patches are out.
> 
> Mimi worked with me from the beginning.

Re: Linux IMA documentation

[Ken Goldman]

On 9/13/2023 10:16 AM, Roberto Sassu wrote:
> I think your document is a good candidate for being put in 
> Documentation/admin-guide/LSM/, once my patch set is upstreamed: 
> https://lore.kernel.org/linux-integrity/20230904133415.1799503-1-roberto.sassu@huaweicloud.com/

Isn't the documentation separate from this proposed patch?  It doesn't 
claim to document how code works.

What's the process for proposing this work for inclusion in the 
documentation?

Re: Linux IMA documentation

[Mimi Zohar]

On Wed, 2023-09-20 at 15:02 -0400, Ken Goldman wrote:
> On 9/13/2023 10:16 AM, Roberto Sassu wrote:
> > I think your document is a good candidate for being put in 
> > Documentation/admin-guide/LSM/, once my patch set is upstreamed: 
> > https://lore.kernel.org/linux-integrity/20230904133415.1799503-1-roberto.sassu@huaweicloud.com/
> 
> Isn't the documentation separate from this proposed patch?  It doesn't 
> claim to document how code works.

Roberto suggested putting the documentation in the LSM documentation
directory after his patch set is upstreamed.   Only then will IMA/EVM
be considered full LSMs.

Mimi