Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial wolfSSH Espressif Component Publish #599

Closed
wants to merge 1 commit into from

Conversation

gojimmypi
Copy link
Contributor

This is a replacement PR for #598 that was inadvertently created on an improper repo branch.

Similar to wolfSSL/wolfssl#6708 these are the files used to publish wolfSSH as a component to the Espressif Component Registry. There are also some changes to the .gitignore file.

These files are not part of wolfSSH library and are only needed to publish wolfSSH to the Espressif ESP Registry:

https://components.espressif.com/components?q=namespace:wolfssl (wolfSSH not yet deployed to production site).

The staging site is at:

https://components-staging.espressif.com/components/gojimmypi/mywolfssh

Note that for the staging site, I have implemented user-specific namespace support in the install script (in my case: gojimmypi and detected with the $USER variable). Additionally, on the staging site components are renamed with a my prefix, to distinguish from production libraries. This allows multiple publishers to publish their own test components individually before using the single production wolfssl namespace and component names. This also aids in support identification if a customer is using experimental staging components.

Only Linux bash script is implemented at this time for publishing.

See the README.md for details. See also #588 and wolfSSL/wolfMQTT#352

The recent updates here include support for the staging site and passing a parameter as to the source code to install:

./wolfssl_component_publish.sh /mnt/c/workspace/wolfssl-master

See the INSTALL.md for files to edit for published version specification and other details.

Closes #588 and partially addresses #428 (a different CMakeLists.txt is needed for non-managed components). PR for that soon in separate examples.

apps/wolfssh/wolfssh
apps/wolfsshd/wolfsshd
apps/wolfsshd/test/test_configuration

# wolfMQTT examples
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are these in the wolfSSH project?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There might be value in having a consistent .gitignore across repos? I found myself copying and pasting various exclusions.

@@ -48,19 +56,34 @@ tags
diff
.vimrc

# examples
# wolfSSL examples
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be "wolfSSH examples".

# Eclipse
*.trs
firmware.bin
wolfmqtt/options.h
Copy link
Contributor

Choose a reason for hiding this comment

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

This is wolfSSH not wolfMQTT.

@@ -0,0 +1,111 @@
#
# Copyright (C) 2006-2022 wolfSSL Inc. All rights reserved.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's 2023.

Copy link
Contributor

Choose a reason for hiding this comment

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

And this is the commercial licensing header. Everything in wolfSSH must be GPLv3.

**/*.vgdbproj.*.user


# Espressif sdk config default should be saved in sdkconfig.defaults
Copy link
Contributor

Choose a reason for hiding this comment

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

The following items are pathed from root, not local to the git repo, why are they here? Git shouldn't see these.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm pretty sure "root" (leading /) with respect to a GitHub repo directory, means "root of repo", not root of file system, no?

@@ -0,0 +1,818 @@
#!/bin/bash
Copy link
Contributor

Choose a reason for hiding this comment

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

This script is touching things in the wolfMQTT directory, wolfSSH doesn't have that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is a parameterized, universal script: the same for wolfSSL, wolfSSH, and wolfMQTT.

Perhaps an argument for a repo of it's own.

@@ -0,0 +1,354 @@

Copy link
Contributor

Choose a reason for hiding this comment

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

Why is the GPLv2 in here? wolfSSH is GPLv3.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This component install was copied & modified from wolfSSL. I missed the GPLv3 for wolfSSL vs GPLv2 wolfSSL


# Licensing and Support

wolfSSL (formerly known as CyaSSL) and wolfCrypt are either licensed for use
Copy link
Contributor

Choose a reason for hiding this comment

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

wolfSSH is GPLv3


# Licensing and Support

wolfSSL (formerly known as CyaSSL) and wolfCrypt are either licensed for use
Copy link
Contributor

Choose a reason for hiding this comment

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

wolfSSH is GPLv3

@ejohnstown ejohnstown removed their assignment Oct 17, 2023
@gojimmypi
Copy link
Contributor Author

gojimmypi commented Nov 22, 2023

I'm revising the publishing & moving to scripts. See also wolfSSL/wolfssl#6708

@gojimmypi gojimmypi closed this Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

wolfSSH Espressif ESP32 Managed Component Support
2 participants