Merge pull request #3 from Seagate/feat/saswwn

feat: SAS attach using WWN, multipath, GUIDEBOOK.md

Author: jskazinski

GUIDEBOOK.md

@@ -25,7 +25,7 @@ install:
 	go install ./sas/
 
 run: build
-	_output/example
+	_output/example -h
 
 test:
 	go test -v ./sas/

Makefile

@@ -1,7 +1,6 @@
-# CSI lib-sas
+# csi-lib-sas
 
-A go package that can be imported to help CSI plugins with connecting to
-SAS devices. Simply import it and get access to the necessary functions.
+A go package that can be imported to help CSI plugins connect to SAS devices. Simply import it and get access to the necessary functions.
 
 ## Goals
 
@@ -10,9 +9,15 @@ Provide a basic, lightweight library for CSI Plugin Authors to leverage some of
 We intentionally avoid pulling in additional dependencies, and we intend to be stateless and as such are not using receivers.  Currently the focus is strictly based on a CSI context.
 
 ## Design Philosophy
- The idea is to keep this as lightweight and generic as possible.  We intentionally avoid the use of any third party
-libraries or packages in this project.  We don't have a vendor directory, because we attempt to rely only on the std
-golang libs.  This may prove to not be ideal, and may be changed over time, but initially it's a worthwhile goal. 
+
+The idea is to keep this as lightweight and generic as possible.  We intentionally avoid the use of any third party libraries or packages in this project.  We don't have a vendor directory, because we attempt to rely only on the std golang libs.
+
+This library leverages structured and contextual logging. Logging verbosity can be increased using the standard -v=# syntax.
+
+## SAS Library Backgroud
+
+- An [example program](example/main.go) is provided for library usage: 
+- A [SAS Guidebook](GUIDEBOOK.md) details SAS specific system information and example program usage.
 
 ## Community, discussion, contribution, and support
 

README.md

@@ -0,0 +1,20 @@
+# SAS Security Policy
+
+We take the security of the csi-lib-sas project seriously. If you find any security vulnerabilities in any of the source code managed via our [GitHub Organization](https://github.com/Seagate) repositories, please report it to us as described below.
+
+## Reporting Security Issues
+
+:warning: **Please do not publicly report any security vulnerabilities via GitHub issues.**
+
+If you have concerns or questions, please email us at [opensource@seagate.com](mailto:opensource@seagate.com). 
+
+To report an actual vulnerability, please use the "[Seagate Responsible Vulnerability Disclosure Policy](https://www.seagate.com/legal-privacy/responsible-vulnerability-disclosure-policy/)"
+ 
+
+### Reporting Format
+
+To make your reporting meaningful and help us understand the nature and scope of the issue, please include as much information as possible. 
+
+### Preferred Languages
+
+We prefer all communications to be in English.

SECURITY.md

@@ -10,5 +10,5 @@
 # DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE
 # INSTRUCTIONS AT https://kubernetes.io/security/
 
-childsb
-saad-ali
+jskazinski
+

SECURITY_CONTACTS

@@ -18,38 +18,65 @@ package main
 import (
 	"context"
 	"flag"
-	"strings"
+	"fmt"
 
 	"github.com/Seagate/csi-lib-sas/sas"
 	"k8s.io/klog/v2"
 )
 
+// Define usage and some common examples
+const (
+	usage = `====================================================================================================
+example - Run the SAS Library Example Program
+
+Examples:
+./example -wwn 600c0ff000546067369fe36201000000
+./example -wwn 600c0ff000546067369fe36201000000 -v=4
+./example -wwn 600c0ff000546067369fe36201000000 -v=4 -detach
+
+Low level library commands require sudo or root privilege. You must provide a wwn to be succeed.
+
+Options:
+`
+)
+
 func main() {
 	// Enable contextual logging
 	ctx := context.Background()
 	klog.InitFlags(nil)
 	klog.EnableContextualLogging(true)
 	logger := klog.FromContext(ctx)
 
-	wwns := flag.String("wwns", "", "Specify a comma separated list of WWNs")
-	lun := flag.String("lun", "1", "Specify a LUN, defaults to 1")
-	flag.Parse()
+	wwn := flag.String("wwn", "", "Specify a WWN")
+	detach := flag.Bool("detach", false, "automatically detach after a successful attach")
 
-	lcwwns := strings.ToLower(*wwns)
-	logger.Info("[] sas test example", "lun", *lun, "wwns", lcwwns)
+	flag.Usage = func() {
+		fmt.Fprintf(flag.CommandLine.Output(), usage)
+		flag.PrintDefaults()
+	}
 
-	c := sas.Connector{}
+	flag.Parse()
+
+	logger.Info("[] sas test example", "wwn", *wwn, "detach", *detach)
 
 	// Use command line arguments for test settings
-	c.TargetWWNs = strings.Split(lcwwns, ",")
-	c.Lun = *lun
+	c := sas.Connector{
+		TargetWWN: *wwn,
+	}
 
-	dp, err := sas.Attach(ctx, c, &sas.OSioHandler{})
+	dp, err := sas.Attach(ctx, &c, &sas.OSioHandler{})
 
 	if err != nil {
 		logger.Error(err, "SAS Attach failure")
 	} else {
-		logger.Info("SAS Attach success", "devicePath", dp)
-		sas.Detach(ctx, dp, &sas.OSioHandler{})
+		logger.Info("SAS Attach success", "device", dp, "connector", c)
+		if *detach {
+			err = sas.Detach(ctx, dp, &sas.OSioHandler{})
+			if err == nil {
+				logger.Error(err, "SAS Detach success")
+			} else {
+				logger.Error(err, "SAS Detach failure")
+			}
+		}
 	}
 }