search

infobyte / faraday

Open Source Vulnerability Management Platform
https://www.faradaysec.com
GNU General Public License v3.0
4.87k stars 893 forks source link

[Bug] Workspace name can't contain uppercase #361

Open noraj opened 5 years ago

noraj commented 5 years ago

Description

An alert tells me Error: Workspace name can not contain white spaces or start with uppercase. when I try to name the workspace testWorkspace but testWorkspace doesn't start with an uppercase and contains no white-space.

This may due to a bad regex matching white-space at any position instead of checking the first char only.

Issue Type

Faraday version

Faraday v3.7.0

Component Name

I don't know.

Steps to reproduce

Expected results

I could name a workspace testWorkspace.

Debugging tracebacks (current results)

It is more a bad implementation than a bug so there are not debug logs.

Screenshots

image

Environment information

Configuration files

No needed. I changed nothing pure default.

OS

Provide information on your operating system. Example:

$ cat /etc/lsb-release DISTRIB_ID=Ubuntu DISTRIB_RELEASE=16.10 DISTRIB_CODENAME=yakkety DISTRIB_DESCRIPTION="Ubuntu 16.10"

:rofl: /etc/lsb-release? The standard file is /etc/os-release. #362

cat /etc/os-release 
NAME="Arch Linux"
PRETTY_NAME="Arch Linux"
ID=arch
BUILD_ID=rolling
ANSI_COLOR="0;36"
HOME_URL="https://www.archlinux.org/"
DOCUMENTATION_URL="https://wiki.archlinux.org/"
SUPPORT_URL="https://bbs.archlinux.org/"
BUG_REPORT_URL="https://bugs.archlinux.org/"
LOGO=archlinux
noraj commented 5 years ago

PS: Should I also fill a feature request to have Workspace name supports spaces and uppercase letter at first char?

llazzaro commented 5 years ago

@noraj It's ok to leave it here. We may add support for upper on first char. For white spaces we need to add a slug, since workspace name is used on the api urls.

noraj commented 5 years ago

@llazzaro Or you can associate a UID to each workspace and use the UID in the API. The UID is unique and never change, then you can associate whatever name at it and even rename the workspace.

llazzaro commented 5 years ago

We have been discussing this issue with the dev team. The problem of using UID is backwards compatbility. We could start to use the UID for new workspaces and use the current workspace name for old workpsaces. A lot of peopel are usign integrations with the faraday API.

The restriction on the workspace name cames from the couchdb era, where the workspace name was the couchdb database name.