search

oasis-open / cti-python-stix2

OASIS TC Open Repository: Python APIs for STIX 2
https://stix2.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
367 stars 120 forks source link

Property Name Discrepancies in Stix2 Cyber Observable Extensions #194

Closed tigerkatz closed 6 years ago

tigerkatz commented 6 years ago

I recently noticed the following discrepancies between the property names in Python and the Official Stix documentation for a few Cyber Observable Extensions. The discrepancies I have found are as follows.

  1. Python stix2.RasterImageExt has property "image_weight" but the documentation specifies "image_width". Link to doc here.

  2. Python stix2.WindowsPEBinaryExt Optional Header Type has properties "major_os_version" and "minor_os_version" but the documentation specifies "major_os_system_version" and "minor_os_system_version." Link to doc here.

Thank you

Josh

gtback commented 6 years ago

Thanks for reporting this, @tigerkatz . We'll look into fixing this.

gtback commented 6 years ago

The first item (RasterImageExt.image_weight) is definitely a problem. It's not used in any of the examples, so it wasn't caught by any tests.

The second item looks like a discrepancy in the specification between the Property table (which uses major_os_version) and the example (which uses major_os_system_version). It looks like the former is what was intended, and version 2.1 uses major_os_version in both places, so I don't think this one needs to be changed. Do you agree, @tigerkatz ?

tigerkatz commented 6 years ago

That makes sense. So I suppose only the example on the documentation site needs to be changed for the second one. Thank you.

On Wed, Jun 20, 2018 at 4:23 PM, Greg Back notifications@github.com wrote:

The first item (RasterImageExt.image_weight) is definitely a problem. It's not used in any of the examples, so it wasn't caught by any tests.

The second item looks like a discrepancy in the specification between the Property table (which uses major_os_version) and the example (which uses major_os_system_version). It looks like the former is what was intended, and version 2.1 https://docs.google.com/document/d/1epBSNorAYmBVfFnIKNgDzPSXLapL13Jmsmw-WsVfUoY/edit#heading=h.gg5zibddf9bs uses major_os_version in both places, so I don't think this one needs to be changed. Do you agree, @tigerkatz https://github.com/tigerkatz ?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/oasis-open/cti-python-stix2/issues/194#issuecomment-398884357, or mute the thread https://github.com/notifications/unsubscribe-auth/AlusGLxhOW_QuoJlkT5KzvzMErJ7EwL_ks5t-q8_gaJpZM4Uvb_7 .

rpiazza commented 6 years ago

@tigerkatz: Greg was right - this was an error that I caught, and it was corrected for 2.1. Unfortunately, at this point, I think we are unable to change the standards document for 2.0. I'm not sure how how OASIS handles errata.