/*
|
* Copyright 2011 gitblit.com.
|
*
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
* you may not use this file except in compliance with the License.
|
* You may obtain a copy of the License at
|
*
|
* http://www.apache.org/licenses/LICENSE-2.0
|
*
|
* Unless required by applicable law or agreed to in writing, software
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* See the License for the specific language governing permissions and
|
* limitations under the License.
|
*/
|
package com.gitblit;
|
|
import java.text.MessageFormat;
|
|
import com.gitblit.Constants.AccessRestrictionType;
|
import com.gitblit.models.RepositoryModel;
|
import com.gitblit.models.UserModel;
|
import com.gitblit.utils.StringUtils;
|
|
/**
|
* The GitFilter is an AccessRestrictionFilter which ensures that Git client
|
* requests for push, clone, or view restricted repositories are authenticated
|
* and authorized.
|
*
|
* @author James Moger
|
*
|
*/
|
public class GitFilter extends AccessRestrictionFilter {
|
|
protected final String gitReceivePack = "/git-receive-pack";
|
|
protected final String gitUploadPack = "/git-upload-pack";
|
|
protected final String[] suffixes = { gitReceivePack, gitUploadPack, "/info/refs", "/HEAD",
|
"/objects" };
|
|
/**
|
* Extract the repository name from the url.
|
*
|
* @param url
|
* @return repository name
|
*/
|
@Override
|
protected String extractRepositoryName(String url) {
|
String repository = url;
|
// get the repository name from the url by finding a known url suffix
|
for (String urlSuffix : suffixes) {
|
if (repository.indexOf(urlSuffix) > -1) {
|
repository = repository.substring(0, repository.indexOf(urlSuffix));
|
}
|
}
|
return repository;
|
}
|
|
/**
|
* Analyze the url and returns the action of the request. Return values are
|
* either "/git-receive-pack" or "/git-upload-pack".
|
*
|
* @param serverUrl
|
* @return action of the request
|
*/
|
@Override
|
protected String getUrlRequestAction(String suffix) {
|
if (!StringUtils.isEmpty(suffix)) {
|
if (suffix.startsWith(gitReceivePack)) {
|
return gitReceivePack;
|
} else if (suffix.startsWith(gitUploadPack)) {
|
return gitUploadPack;
|
} else if (suffix.contains("?service=git-receive-pack")) {
|
return gitReceivePack;
|
} else if (suffix.contains("?service=git-upload-pack")) {
|
return gitUploadPack;
|
} else {
|
return gitUploadPack;
|
}
|
}
|
return null;
|
}
|
|
/**
|
* Determine if the repository requires authentication.
|
*
|
* @param repository
|
* @return true if authentication required
|
*/
|
@Override
|
protected boolean requiresAuthentication(RepositoryModel repository) {
|
return repository.accessRestriction.atLeast(AccessRestrictionType.PUSH);
|
}
|
|
/**
|
* Determine if the user can access the repository and perform the specified
|
* action.
|
*
|
* @param repository
|
* @param user
|
* @param action
|
* @return true if user may execute the action on the repository
|
*/
|
@Override
|
protected boolean canAccess(RepositoryModel repository, UserModel user, String action) {
|
if (!GitBlit.getBoolean(Keys.git.enableGitServlet, true)) {
|
// Git Servlet disabled
|
return false;
|
}
|
boolean readOnly = repository.isFrozen;
|
if (readOnly || repository.accessRestriction.atLeast(AccessRestrictionType.PUSH)) {
|
boolean authorizedUser = user.canAccessRepository(repository);
|
if (action.equals(gitReceivePack)) {
|
// Push request
|
if (!readOnly && authorizedUser) {
|
// clone-restricted or push-authorized
|
return true;
|
} else {
|
// user is unauthorized to push to this repository
|
logger.warn(MessageFormat.format("user {0} is not authorized to push to {1}",
|
user.username, repository));
|
return false;
|
}
|
} else if (action.equals(gitUploadPack)) {
|
// Clone request
|
boolean cloneRestricted = repository.accessRestriction
|
.atLeast(AccessRestrictionType.CLONE);
|
if (!cloneRestricted || (cloneRestricted && authorizedUser)) {
|
// push-restricted or clone-authorized
|
return true;
|
} else {
|
// user is unauthorized to clone this repository
|
logger.warn(MessageFormat.format("user {0} is not authorized to clone {1}",
|
user.username, repository));
|
return false;
|
}
|
}
|
}
|
return true;
|
}
|
}
|
