Skip to content

Commit

Permalink
Implement git:// protocol check
Browse files Browse the repository at this point in the history
  • Loading branch information
ffaf1 authored and Mikolaj committed Aug 20, 2024
1 parent cc65775 commit e8af2d3
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
12 changes: 12 additions & 0 deletions Cabal/src/Distribution/PackageDescription/Check.hs
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,7 @@ checkSourceRepos rs = do
checkP
(isNothing repoLocation_)
(PackageDistInexcusable MissingLocation)
checkGitProtocol repoLocation_
checkP
( repoType_ == Just (KnownRepoType CVS)
&& isNothing repoModule_
Expand Down Expand Up @@ -722,6 +723,17 @@ checkMissingVcsInfo rs =
repoTypeDirname Monotone = ["_MTN"]
repoTypeDirname Pijul = [".pijul"]

-- git:// lacks TLS or other encryption, see
-- https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_cons_4
checkGitProtocol
:: Monad m
=> Maybe String -- Repository location
-> CheckM m ()
checkGitProtocol mloc =
checkP
(fmap (isPrefixOf "git://") mloc == Just True)
(PackageBuildWarning GitProtocol)

-- ------------------------------------------------------------
-- Package and distribution checks
-- ------------------------------------------------------------
Expand Down
7 changes: 7 additions & 0 deletions Cabal/src/Distribution/PackageDescription/Check/Warning.hs
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ data CheckExplanation
| UnrecognisedSourceRepo String
| MissingType
| MissingLocation
| GitProtocol
| MissingModule
| MissingTag
| SubdirRelPath
Expand Down Expand Up @@ -355,6 +356,7 @@ data CheckExplanationID
| CIUnrecognisedSourceRepo
| CIMissingType
| CIMissingLocation
| CIGitProtocol
| CIMissingModule
| CIMissingTag
| CISubdirRelPath
Expand Down Expand Up @@ -496,6 +498,7 @@ checkExplanationId (NoLicenseFile{}) = CINoLicenseFile
checkExplanationId (UnrecognisedSourceRepo{}) = CIUnrecognisedSourceRepo
checkExplanationId (MissingType{}) = CIMissingType
checkExplanationId (MissingLocation{}) = CIMissingLocation
checkExplanationId (GitProtocol{}) = CIGitProtocol
checkExplanationId (MissingModule{}) = CIMissingModule
checkExplanationId (MissingTag{}) = CIMissingTag
checkExplanationId (SubdirRelPath{}) = CISubdirRelPath
Expand Down Expand Up @@ -642,6 +645,7 @@ ppCheckExplanationId CINoLicenseFile = "no-license-file"
ppCheckExplanationId CIUnrecognisedSourceRepo = "unrecognised-repo-type"
ppCheckExplanationId CIMissingType = "repo-no-type"
ppCheckExplanationId CIMissingLocation = "repo-no-location"
ppCheckExplanationId CIGitProtocol = "git-protocol"
ppCheckExplanationId CIMissingModule = "repo-no-module"
ppCheckExplanationId CIMissingTag = "repo-no-tag"
ppCheckExplanationId CISubdirRelPath = "repo-relative-dir"
Expand Down Expand Up @@ -964,6 +968,9 @@ ppExplanation MissingType =
"The source-repository 'type' is a required field."
ppExplanation MissingLocation =
"The source-repository 'location' is a required field."
ppExplanation GitProtocol =
"Cloning over git:// might lead to an arbitrary code execution "
++ "vulnerability. Use https:// or ssh:// instead."
ppExplanation MissingModule =
"For a CVS source-repository, the 'module' is a required field."
ppExplanation MissingTag =
Expand Down

0 comments on commit e8af2d3

Please sign in to comment.