You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jdo-dev@db.apache.org by Craig Russell <ap...@gmail.com> on 2024/11/07 00:54:01 UTC

SBOM for existing project: DB JDO

Hi,

The DB JDO project is interested in creating SBOMs for our releases. Is there a good tutorial for the uninformed as to how to actually produce SBOMs? 

I know that the security team is working on documenting existing SBOMs for some projects. I looked at the security web site and it did not yield much information how to get started.

If this is the wrong list for this please let us know.

Thanks,
Craig

Craig L Russell
clr@apache.org


Re: SBOM for existing project: DB JDO

Posted by Lars Francke <la...@gmail.com>.
> It would be recommended to use both formats, although at Logging
> Services we admittedly only use CycloneDX, because it is reproducible[4]
> and has an ASF maintainer (Hervé).

If it ever becomes relevant for Rust based projects: I'm one of the
maintainers of the cyclonedx-rust-cargo plugin:
https://github.com/CycloneDX/cyclonedx-rust-cargo

---------------------------------------------------------------------
To unsubscribe, e-mail: security-discuss-unsubscribe@community.apache.org
For additional commands, e-mail: security-discuss-help@community.apache.org


Re: SBOM for existing project: DB JDO

Posted by "Piotr P. Karwasz" <pi...@mailing.copernik.eu>.
Hi Jarek,

On 7.11.2024 02:48, Jarek Potiuk wrote:
> As I understand - most Java project that use maven, can simply use
> cyclonedx-maven plugin https://github.com/CycloneDX/cyclonedx-maven-plugin and
> I guess basically that's how you start - and I think that's where JDO team
> can start.
> Airflow - being mostly a Python + some javascript project uses CDXGEN
> https://cyclonedx.github.io/cdxgen/. - which is another way of generating
> sboms (and they have a number of tutorials), but likely the maven route is
> simpler for those who already use maven.
>
> I personally do not know much about the maven plugin, so can't say more -
> but probably looking at the docs and looking at other - similar - projects
> in the list above and seeing how they are producing it, might be is a good
> start, and maybe the JDO team could ask their questions in the thread here
> after following the cyclonedx maven plugin docs and looking at the other
> list.

For completeness' sake, there are actually two Maven plugins for SBOMs:

* `cyclonedx-maven-plugin` produces SBOMs in CycloneDX format[1], which 
is an Ecma standard of the OWASP Foundation.

* `spdx-maven-plugin`[2] produces SBOMs in SPDX[3] format, which is an 
ISO standard of the Linux Foundation.

It would be recommended to use both formats, although at Logging 
Services we admittedly only use CycloneDX, because it is reproducible[4] 
and has an ASF maintainer (Hervé).

Both plugins are pretty straightforward to use. The philosophy of the 
CycloneDX plugin (as with most Maven plugins) is to give users only a 
few choices and have the right defaults. The most important choices IMHO 
are:

* whether to also publish an aggregated SBOM for the Maven aggregator 
module (`org.apache:jdo` in your case) or not. The aggregated SBOM 
basically merges all the SBOM of the multi-module Maven project. Its 
usefulness is debatable.

* what external references[5] do you want to appear in your SBOM. The 
list of possible references is long[6], but you should at least check 
those that are automatically added. This is when we discovered that most 
of the URLs in our POMs did not resolve and we had to add magical 
`child.*.inherit.append.path`[7] attributes to the parent.

Piotr

[1] https://cyclonedx.org/

[2] https://github.com/spdx/spdx-maven-plugin

[3] https://spdx.dev/

[4] https://maven.apache.org/guides/mini/guide-reproducible-builds.html

[5] 
https://cyclonedx.github.io/cyclonedx-maven-plugin/external-references.html

[6] https://cyclonedx.org/docs/1.6/json/#externalReferences_items_type

[7] https://maven.apache.org/ref/3.9.9/maven-model-builder/


---------------------------------------------------------------------
To unsubscribe, e-mail: security-discuss-unsubscribe@community.apache.org
For additional commands, e-mail: security-discuss-help@community.apache.org


Re: SBOM for existing project: DB JDO

Posted by Jarek Potiuk <ja...@potiuk.com>.
Personally I think it's great we have PMCs asking for it :), and it's a
great opportunity to start writing guidelines with the help of those
projects who are eager to try.

I think we are still early in getting good guidelines - we are learning how
to do it in different cases - and eventually yeah - we will likely produce
some good guides. I think there are a few nuances and definitely different
paths you can make for now - and maybe the JDO community can test those
that we have now, explore what they find and report here if they (and how)
manage to find their way. And we can use that discussion as a good learning
project.

I will also let others comment from their perspective and we can share our
knowledge this way - because also, our knowledge is pretty distributed now.

Arnout is putting the sboms from a number of ASF projects together and
Herve recently added this PR with page summarising SBOM status for some of
our project https://github.com/apache/security-site/pull/21/ which I do not
think is published yet on "security.apache.org" - but you can see it here
https://github.com/hboutemy/security-site/blob/87823ed212c6ce740fc2dceee774c97523575cdc/sboms/README.md

As I understand - most Java project that use maven, can simply use
cyclonedx-maven plugin https://github.com/CycloneDX/cyclonedx-maven-plugin and
I guess basically that's how you start - and I think that's where JDO team
can start.
Airflow - being mostly a Python + some javascript project uses CDXGEN
https://cyclonedx.github.io/cdxgen/. - which is another way of generating
sboms (and they have a number of tutorials), but likely the maven route is
simpler for those who already use maven.

I personally do not know much about the maven plugin, so can't say more -
but probably looking at the docs and looking at other - similar - projects
in the list above and seeing how they are producing it, might be is a good
start, and maybe the JDO team could ask their questions in the thread here
after following the cyclonedx maven plugin docs and looking at the other
list. That could likely give us a fantastic start on "what questions our
projects can ask" and "what answers we can give" , "where they
are completely lost" etc. - ultimately landing those as some guidelines
/faqs after we try it with few other projects.

JDO community - could you try to follow the path above and ask the
questions in the thread so that we could build such "good guidelines" for
others ?

J.


On Thu, Nov 7, 2024 at 12:55 AM Craig Russell <ap...@gmail.com> wrote:

> Hi,
>
> The DB JDO project is interested in creating SBOMs for our releases. Is
> there a good tutorial for the uninformed as to how to actually produce
> SBOMs?
>
> I know that the security team is working on documenting existing SBOMs for
> some projects. I looked at the security web site and it did not yield much
> information how to get started.
>
> If this is the wrong list for this please let us know.
>
> Thanks,
> Craig
>
> Craig L Russell
> clr@apache.org
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: security-discuss-unsubscribe@community.apache.org
> For additional commands, e-mail:
> security-discuss-help@community.apache.org
>
>

Re: SBOM for existing project: DB JDO

Posted by Arnout Engelen <en...@apache.org>.
Great to hear!

Piotr and Jarek already summarized things very nicely, but for reference:
did you see
https://cwiki.apache.org/confluence/display/SECURITY/SBOM+Software+Bill+of+Materials?
If you didn't, where did you look / expect to find it? If/now that you
found it, was there anything in particular that you missed in that
document? Feedback from a project that still has the "Beginners' Mind" is
very valuable here!


Kind regards,

Arnout


On Thu, Nov 7, 2024 at 1:54 AM Craig Russell <ap...@gmail.com> wrote:

> Hi,
>
> The DB JDO project is interested in creating SBOMs for our releases. Is
> there a good tutorial for the uninformed as to how to actually produce
> SBOMs?
>
> I know that the security team is working on documenting existing SBOMs for
> some projects. I looked at the security web site and it did not yield much
> information how to get started.
>
> If this is the wrong list for this please let us know.
>
> Thanks,
> Craig
>
> Craig L Russell
> clr@apache.org
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: security-discuss-unsubscribe@community.apache.org
> For additional commands, e-mail:
> security-discuss-help@community.apache.org
>
>

-- 
Arnout Engelen
ASF Security Response
Apache Pekko PMC member, ASF Member
NixOS Committer
Independent Open Source consultant

Re: SBOM for existing project: DB JDO

Posted by Jarek Potiuk <ja...@potiuk.com>.
Personally I think it's great we have PMCs asking for it :), and it's a
great opportunity to start writing guidelines with the help of those
projects who are eager to try.

I think we are still early in getting good guidelines - we are learning how
to do it in different cases - and eventually yeah - we will likely produce
some good guides. I think there are a few nuances and definitely different
paths you can make for now - and maybe the JDO community can test those
that we have now, explore what they find and report here if they (and how)
manage to find their way. And we can use that discussion as a good learning
project.

I will also let others comment from their perspective and we can share our
knowledge this way - because also, our knowledge is pretty distributed now.

Arnout is putting the sboms from a number of ASF projects together and
Herve recently added this PR with page summarising SBOM status for some of
our project https://github.com/apache/security-site/pull/21/ which I do not
think is published yet on "security.apache.org" - but you can see it here
https://github.com/hboutemy/security-site/blob/87823ed212c6ce740fc2dceee774c97523575cdc/sboms/README.md

As I understand - most Java project that use maven, can simply use
cyclonedx-maven plugin https://github.com/CycloneDX/cyclonedx-maven-plugin and
I guess basically that's how you start - and I think that's where JDO team
can start.
Airflow - being mostly a Python + some javascript project uses CDXGEN
https://cyclonedx.github.io/cdxgen/. - which is another way of generating
sboms (and they have a number of tutorials), but likely the maven route is
simpler for those who already use maven.

I personally do not know much about the maven plugin, so can't say more -
but probably looking at the docs and looking at other - similar - projects
in the list above and seeing how they are producing it, might be is a good
start, and maybe the JDO team could ask their questions in the thread here
after following the cyclonedx maven plugin docs and looking at the other
list. That could likely give us a fantastic start on "what questions our
projects can ask" and "what answers we can give" , "where they
are completely lost" etc. - ultimately landing those as some guidelines
/faqs after we try it with few other projects.

JDO community - could you try to follow the path above and ask the
questions in the thread so that we could build such "good guidelines" for
others ?

J.


On Thu, Nov 7, 2024 at 12:55 AM Craig Russell <ap...@gmail.com> wrote:

> Hi,
>
> The DB JDO project is interested in creating SBOMs for our releases. Is
> there a good tutorial for the uninformed as to how to actually produce
> SBOMs?
>
> I know that the security team is working on documenting existing SBOMs for
> some projects. I looked at the security web site and it did not yield much
> information how to get started.
>
> If this is the wrong list for this please let us know.
>
> Thanks,
> Craig
>
> Craig L Russell
> clr@apache.org
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: security-discuss-unsubscribe@community.apache.org
> For additional commands, e-mail:
> security-discuss-help@community.apache.org
>
>

Re: SBOM for existing project: DB JDO

Posted by Arnout Engelen <en...@apache.org>.
Great to hear!

Piotr and Jarek already summarized things very nicely, but for reference:
did you see
https://cwiki.apache.org/confluence/display/SECURITY/SBOM+Software+Bill+of+Materials?
If you didn't, where did you look / expect to find it? If/now that you
found it, was there anything in particular that you missed in that
document? Feedback from a project that still has the "Beginners' Mind" is
very valuable here!


Kind regards,

Arnout


On Thu, Nov 7, 2024 at 1:54 AM Craig Russell <ap...@gmail.com> wrote:

> Hi,
>
> The DB JDO project is interested in creating SBOMs for our releases. Is
> there a good tutorial for the uninformed as to how to actually produce
> SBOMs?
>
> I know that the security team is working on documenting existing SBOMs for
> some projects. I looked at the security web site and it did not yield much
> information how to get started.
>
> If this is the wrong list for this please let us know.
>
> Thanks,
> Craig
>
> Craig L Russell
> clr@apache.org
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: security-discuss-unsubscribe@community.apache.org
> For additional commands, e-mail:
> security-discuss-help@community.apache.org
>
>

-- 
Arnout Engelen
ASF Security Response
Apache Pekko PMC member, ASF Member
NixOS Committer
Independent Open Source consultant