Skip to content

FIPS: Add cli command to display macsec fips module#24493

Merged
rlhui merged 15 commits intosonic-net:masterfrom
wumiaont:master
Jan 28, 2026
Merged

FIPS: Add cli command to display macsec fips module#24493
rlhui merged 15 commits intosonic-net:masterfrom
wumiaont:master

Conversation

@wumiaont
Copy link
Copy Markdown
Contributor

Why I did it

FIPS lab requires SONiC to have cli support to display MACSEC FIPS module. The output will be in the coming FIPS certificate to indicate the MACSEC module been certified.

Data center security officer will use this CLI command to check the FIPS module output and compare with what is in the certificate to make sure the MACsec module is the certified one.

Work item tracking
  • Microsoft ADO (number only):

How I did it

Add cli support "show macsec --fips-module". Output is vendor specific. Each vendor should update their platform.json to have fips_module defined there.

How to verify it

Have implemented unit test code to verify the code works.

Which release branch to backport (provide reason below if selected)

  • 202205
  • 202211
  • 202305
  • 202311
  • 202405
  • 202411
  • 202505
  • 202511

Tested branch (Please provide the tested image version)

Test with master.

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

@wumiaont wumiaont requested a review from lguohan as a code owner November 11, 2025 20:21
@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link
Copy Markdown

Commenter does not have sufficient privileges for PR 24493 in repo sonic-net/sonic-buildimage

@wumiaont wumiaont changed the title Add cli command to display macsec fips module FIPS: Add cli command to display macsec fips module Nov 19, 2025
Copy link
Copy Markdown
Contributor

@Pterosaur Pterosaur left a comment

Choose a reason for hiding this comment

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

lgtm

@rlhui
Copy link
Copy Markdown
Contributor

rlhui commented Nov 26, 2025

@vmittal-msft would you help on this PR build? thanks.

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

Copy link
Copy Markdown
Contributor

@judyjoseph judyjoseph left a comment

Choose a reason for hiding this comment

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

@wumiaont can you clarify benefit of adding this in show output. Does each vendor need to define fips module name in platform file.

@wumiaont
Copy link
Copy Markdown
Contributor Author

wumiaont commented Dec 10, 2025

@wumiaont can you clarify benefit of adding this in show output. Does each vendor need to define fips module name in platform file.

@judyjoseph FIPS certificate will list the macsec FIPS module name on the certificate. FIPS lab required SONiC to have a CLI command to display the macsec FIPS module name so security officer in the data center can check the deployed system is running the same module as FIPS certificate shows.

Yes. This FIPS module name is vendor specific. Each vendor can provide this name in the vendor specific platform.json and this CLI will display it. If vendor doesn't provide it will have no output for this command.

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@judyjoseph judyjoseph self-requested a review December 17, 2025 06:46
@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@judyjoseph
Copy link
Copy Markdown
Contributor

judyjoseph commented Dec 17, 2025

@wumiaont can you clarify benefit of adding this in show output. Does each vendor need to define fips module name in platform file.

@judyjoseph FIPS certificate will list the macsec FIPS module name on the certificate. FIPS lab required SONiC to have a CLI command to display the macsec FIPS module name so security officer in the data center can check the deployed system is running the same module as FIPS certificate shows.

Yes. This FIPS module name is vendor specific. Each vendor can provide this name in the vendor specific platform.json and this CLI will display it. If vendor doesn't provide it will have no output for this command.

Sure, so so this name "Nokia-SONiC-MACsec-Version 1.0" signify something? (like a particular version of SAI macsec library, ssl library etc )

@wumiaont
Copy link
Copy Markdown
Contributor Author

Nokia-SONiC-MACsec-Version 1.0

Nokia-SONiC-MACsec-Version 1.0 is the name for the FIPS module on Nokia chassis. This includes software (BCOM SDK 6.5.34 FIPS module) + hardware (BCOM J2c+ 88852 chip). This name will be put in the certificate and future security officer uses this CLI command to check chassis to make sure it runs with the exact FIPS module.

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@mssonicbld
Copy link
Copy Markdown
Collaborator

/azp run Azure.sonic-buildimage

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@wumiaont
Copy link
Copy Markdown
Contributor Author

@vmittal-msft @judyjoseph The sanity check passed. Can you help to merge it to master? We need this for 202511.

@rlhui rlhui merged commit 1c2544d into sonic-net:master Jan 28, 2026
23 of 24 checks passed
xincunli-sonic pushed a commit to xincunli-sonic/sonic-buildimage that referenced this pull request Feb 2, 2026
* Add cli command to display macsec fips module

* Pull latest. Signed-off-by: Wu Miao<[email protected]>

Signed-off-by: Xincun Li <[email protected]>
FengPan-Frank pushed a commit to FengPan-Frank/sonic-buildimage that referenced this pull request Mar 6, 2026
* Add cli command to display macsec fips module

* Pull latest. Signed-off-by: Wu Miao<[email protected]>

Signed-off-by: Feng Pan <[email protected]>
dprital pushed a commit that referenced this pull request Mar 19, 2026
* Add cli command to display macsec fips module

* Pull latest. Signed-off-by: Wu Miao<[email protected]>

Signed-off-by: dprital <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

7 participants