hookfs

KO | EN

gitlite — search

#typescript #llm #go #android #machine-learning #linux #docker #macos #java #awesome #cli #awesome-list #security #mcp

(★ 45)

A Usermode Hookable Filesystem Library

hookfs 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# HookFS: A Usermode Hookable Filesystem Library

[![GoDoc](https://godoc.org/github.com/osrg/hookfs?status.svg)](https://godoc.org/github.com/osrg/hookfs)

## Possible Recipes

* Fault Injection (Example: [Namazu](https://github.com/osrg/namazu))
* Cache
* Malware Detection

and so on..

HookFS was originally developed for [Namazu](https://github.com/osrg/namazu), but we believe HookFS can be also used for other purposes.

## Install

$ go get github.com/osrg/hookfs/hookfs

## Running an Example

$ cd example/ex01
    $ go build
    $ ./ex01 "/mnt/hookfs" "/original"
	^C
    $ fusermount -u "/mnt/hookfs"

## API Design
You have to implement `HookXXX` (e.g. `HookOnOpen`, `HookOnRead`, `HookOnWrite`, ..)  interfaces.

```go
type HookOnRead interface {
	// if hooked is true, the real read() would not be called	
	PreRead(path string, length int64, offset int64) (buf []byte, hooked bool, ctx HookContext, err error)
	PostRead(realRetCode int32, realBuf []byte, prehookCtx HookContext) (buf []byte, hooked bool, err error)
}
```
	
Then, regist your hook implementation to the HookFS server.

```go
fs, err := NewHookFs("/original", "/mnt/hookfs", &YourHook{})
if err != nil { .. }
err = fs.Serve()
```

See [`hook.go`](hookfs/hook.go) for further information. [GoDoc](https://godoc.org/github.com/osrg/hookfs) is also your friend.

## Related Projects
* [Namazu (Earthquake)](https://github.com/osrg/namazu)
* [HookSwitch](https://github.com/osrg/hookswitch)

## How to Contribute
We welcome your contribution to HookFS.
Please feel free to send your pull requests on github!

## Copyright
Copyright (C) 2015 [Nippon Telegraph and Telephone Corporation](http://www.ntt.co.jp/index_e.html).

Released under [Apache License 2.0](LICENSE).

hookfs

hookfs 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

hookfs

hookfs 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README