Detect and block a binary file

kalap92

Is it possible to write a script in Adaptavist ScriptRunner which detects any binary file and denies commit which includes the file?

adammarkham

Hi Piotr,

You can do this with ScriptRunner for Bitbucket Server. You need to use the pre-receive hook "protect git references" . You can enable this by going to Admin -> Pre-receive hooks -> Protect git references. The documentation for that is here.

You'll need to use a condition like the following on that hook to exclude the binary file extensions: 

pathsMatch('regex:.*\\.jar$|.*\\.exe$')

The example above shows you how to do it for jar and exe files.

You can also use the "restrict file size" hook here to block files based on file size, which you may find useful to combine with the rule above.

Alternatively you can use the following as a custom pre-receive hook, but it may not catch every case. You should try it and see if it works for you:

import com.atlassian.bitbucket.commit.CommitService
import com.atlassian.bitbucket.content.AbstractDiffContentCallback
import com.atlassian.bitbucket.content.DiffRequest
import com.atlassian.bitbucket.content.Path
import com.atlassian.bitbucket.hook.HookResponse
import com.atlassian.bitbucket.repository.RefChange
import com.atlassian.bitbucket.repository.RefChangeType
import com.atlassian.bitbucket.repository.Repository
import com.atlassian.sal.api.component.ComponentLocator
import com.onresolve.scriptrunner.canned.bitbucket.util.BitbucketCannedScriptUtils

import javax.annotation.Nullable

def commitService = ComponentLocator.getComponent(CommitService)

def repository = repository as Repository
def refChanges = refChanges as Collection<RefChange>
def hookResponse = hookResponse as HookResponse

def msg = new StringBuilder()

refChanges.each { refChange ->
if (refChange.type != RefChangeType.DELETE) {

def commits = refChange.getCommits(repository)
if (!commits) {
// empty branch
            return
        }
def diffRequestBuilder = new DiffRequest.Builder(repository, refChange.toHash)

        commits.first().parents.each {
            diffRequestBuilder.sinceId(it.id)
        }

        commitService.streamDiff(diffRequestBuilder.build(), new AbstractDiffContentCallback() {
@Override
            void onBinary(@Nullable Path src, @Nullable Path dst) throws IOException {
                msg << "Binary file $dst not allowed - on branch: ${refChange.ref.id}"
                super.onBinary(src, dst)
            }
        })
    }
}

if (msg) {
    hookResponse.out().write BitbucketCannedScriptUtils.wrapHookResponse(msg)
return false
}

return true

Hope this helps.

Adam