Merge branch 'gorm_integration'

pull/24/head
Jordan 2014-03-27 13:21:32 -05:00
commit ac7fda0b04
15 changed files with 217 additions and 182 deletions

View File

@ -3,3 +3,7 @@ language: go
go: go:
- 1.1 - 1.1
- tip - tip
install:
- go get -d -v ./... && go build -v ./...
- go get launchpad.net/gocheck

View File

@ -33,7 +33,7 @@ func Login(r *http.Request) (bool, error) {
username, password := r.FormValue("username"), r.FormValue("password") username, password := r.FormValue("username"), r.FormValue("password")
session, _ := Store.Get(r, "gophish") session, _ := Store.Get(r, "gophish")
u, err := models.GetUserByUsername(username) u, err := models.GetUserByUsername(username)
if err != models.ErrUsernameTaken { if err != nil && err != models.ErrUsernameTaken {
return false, err return false, err
} }
//If we've made it here, we should have a valid user stored in u //If we've made it here, we should have a valid user stored in u
@ -61,7 +61,7 @@ func Register(r *http.Request) (bool, error) {
h, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost) h, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
u.Username = username u.Username = username
u.Hash = string(h) u.Hash = string(h)
u.APIKey = GenerateSecureKey() u.ApiKey = GenerateSecureKey()
if err != nil { if err != nil {
return false, err return false, err
} }

View File

@ -4,7 +4,6 @@ import (
"encoding/json" "encoding/json"
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"os"
) )
type SMTPServer struct { type SMTPServer struct {
@ -27,7 +26,6 @@ func init() {
config_file, err := ioutil.ReadFile("./config.json") config_file, err := ioutil.ReadFile("./config.json")
if err != nil { if err != nil {
fmt.Printf("File error: %v\n", err) fmt.Printf("File error: %v\n", err)
os.Exit(1)
} }
json.Unmarshal(config_file, &Conf) json.Unmarshal(config_file, &Conf)
} }

View File

@ -39,7 +39,7 @@ func API_Reset(w http.ResponseWriter, r *http.Request) {
switch { switch {
case r.Method == "POST": case r.Method == "POST":
u := ctx.Get(r, "user").(models.User) u := ctx.Get(r, "user").(models.User)
u.APIKey = auth.GenerateSecureKey() u.ApiKey = auth.GenerateSecureKey()
err := models.PutUser(&u) err := models.PutUser(&u)
if err != nil { if err != nil {
Flash(w, r, "danger", "Error resetting API Key") Flash(w, r, "danger", "Error resetting API Key")
@ -80,6 +80,7 @@ func API_Campaigns(w http.ResponseWriter, r *http.Request) {
c.CreatedDate = time.Now() c.CreatedDate = time.Now()
c.CompletedDate = time.Time{} c.CompletedDate = time.Time{}
c.Status = IN_PROGRESS c.Status = IN_PROGRESS
c.UserId = ctx.Get(r, "user_id").(int64)
err = models.PostCampaign(&c, ctx.Get(r, "user_id").(int64)) err = models.PostCampaign(&c, ctx.Get(r, "user_id").(int64))
if checkError(err, w, "Cannot insert campaign into database", http.StatusInternalServerError) { if checkError(err, w, "Cannot insert campaign into database", http.StatusInternalServerError) {
return return
@ -175,7 +176,8 @@ func API_Groups(w http.ResponseWriter, r *http.Request) {
return return
} }
g.ModifiedDate = time.Now() g.ModifiedDate = time.Now()
err = models.PostGroup(&g, ctx.Get(r, "user_id").(int64)) g.UserId = ctx.Get(r, "user_id").(int64)
err = models.PostGroup(&g)
if checkError(err, w, "Error inserting group", http.StatusInternalServerError) { if checkError(err, w, "Error inserting group", http.StatusInternalServerError) {
return return
} }
@ -204,11 +206,11 @@ func API_Groups_Id(w http.ResponseWriter, r *http.Request) {
} }
writeJSON(w, gj) writeJSON(w, gj)
case r.Method == "DELETE": case r.Method == "DELETE":
_, err := models.GetGroup(id, ctx.Get(r, "user_id").(int64)) g, err := models.GetGroup(id, ctx.Get(r, "user_id").(int64))
if checkError(err, w, "No group found", http.StatusNotFound) { if checkError(err, w, "No group found", http.StatusNotFound) {
return return
} }
err = models.DeleteGroup(id) err = models.DeleteGroup(&g)
if checkError(err, w, "Error deleting group", http.StatusInternalServerError) { if checkError(err, w, "Error deleting group", http.StatusInternalServerError) {
return return
} }
@ -229,7 +231,9 @@ func API_Groups_Id(w http.ResponseWriter, r *http.Request) {
http.Error(w, "Error: No targets specified", http.StatusBadRequest) http.Error(w, "Error: No targets specified", http.StatusBadRequest)
return return
} }
err = models.PutGroup(&g, ctx.Get(r, "user_id").(int64)) g.ModifiedDate = time.Now()
g.UserId = ctx.Get(r, "user_id").(int64)
err = models.PutGroup(&g)
if checkError(err, w, "Error updating group", http.StatusInternalServerError) { if checkError(err, w, "Error updating group", http.StatusInternalServerError) {
return return
} }

View File

@ -38,7 +38,7 @@ import (
func main() { func main() {
//Setup the global variables and settings //Setup the global variables and settings
err := models.Setup() err := models.Setup()
defer models.DB.Close() //defer models.db.DB().Close()
if err != nil { if err != nil {
fmt.Println(err) fmt.Println(err)
} }

View File

@ -1,14 +0,0 @@
package main
import (
"testing"
"github.com/jordan-wright/gophish/models"
)
func TestDBSetup(t *testing.T) {
err := models.Setup()
if err != nil {
t.Fatalf("Failed creating database: %v", err)
}
}

View File

@ -52,12 +52,13 @@ func RequireAPIKey(handler http.Handler) http.HandlerFunc {
if ak == "" { if ak == "" {
JSONError(w, 400, "API Key not set") JSONError(w, 400, "API Key not set")
} else { } else {
id, err := models.Conn.SelectInt("SELECT id FROM users WHERE api_key=?", ak) u, err := models.GetUserByAPIKey(ak)
if id == 0 || err != nil { /* id, err := models.Conn.SelectInt("SELECT id FROM users WHERE api_key=?", ak)
*/if err != nil {
JSONError(w, 400, "Invalid API Key") JSONError(w, 400, "Invalid API Key")
return return
} }
ctx.Set(r, "user_id", id) ctx.Set(r, "user_id", u.Id)
ctx.Set(r, "api_key", ak) ctx.Set(r, "api_key", ak)
handler.ServeHTTP(w, r) handler.ServeHTTP(w, r)
} }

View File

@ -9,38 +9,48 @@ import (
//Campaign is a struct representing a created campaign //Campaign is a struct representing a created campaign
type Campaign struct { type Campaign struct {
Id int64 `json:"id"` Id int64 `json:"id"`
Name string `json:"name"` UserId int64 `json:"-"`
CreatedDate time.Time `json:"created_date" db:"created_date"` Name string `json:"name" sql:"not null"`
CompletedDate time.Time `json:"completed_date" db:"completed_date"` CreatedDate time.Time `json:"created_date"`
CompletedDate time.Time `json:"completed_date"`
Template string `json:"template"` //This may change Template string `json:"template"` //This may change
Status string `json:"status"` Status string `json:"status"`
Results []Result `json:"results,omitempty" db:"-"` Results []Result `json:"results,omitempty"`
Groups []Group `json:"groups,omitempty" db:"-"` Groups []Group `json:"groups,omitempty"`
} }
type Result struct { type Result struct {
Target Id int64 `json:"-"`
Status string `json:"status"` CampaignId int64 `json:"-"`
Email string `json:"email"`
Status string `json:"status" sql:"not null"`
} }
// GetCampaigns returns the campaigns owned by the given user. // GetCampaigns returns the campaigns owned by the given user.
func GetCampaigns(uid int64) ([]Campaign, error) { func GetCampaigns(uid int64) ([]Campaign, error) {
cs := []Campaign{} cs := []Campaign{}
_, err := Conn.Select(&cs, "SELECT c.id, name, created_date, completed_date, status, template FROM campaigns c, user_campaigns uc, users u WHERE uc.uid=u.id AND uc.cid=c.id AND u.id=?", uid) err := db.Model(&User{Id: uid}).Related(&cs).Error
for i, _ := range cs { if err != nil {
_, err = Conn.Select(&cs[i].Results, "SELECT r.email, r.status FROM campaign_results r WHERE r.cid=?", cs[i].Id) fmt.Println(err)
} }
for i, _ := range cs {
err := db.Model(&cs[i]).Related(&cs[i].Results).Error
if err != nil {
fmt.Println(err)
}
}
fmt.Printf("%v", cs)
return cs, err return cs, err
} }
// GetCampaign returns the campaign, if it exists, specified by the given id and user_id. // GetCampaign returns the campaign, if it exists, specified by the given id and user_id.
func GetCampaign(id int64, uid int64) (Campaign, error) { func GetCampaign(id int64, uid int64) (Campaign, error) {
c := Campaign{} c := Campaign{}
err := Conn.SelectOne(&c, "SELECT c.id, name, created_date, completed_date, status, template FROM campaigns c, user_campaigns uc, users u WHERE uc.uid=u.id AND uc.cid=c.id AND c.id=? AND u.id=?", id, uid) err := db.Where("id = ?", id).Where("user_id = ?", uid).Find(&c).Error
if err != nil { if err != nil {
return c, err return c, err
} }
_, err = Conn.Select(&c.Results, "SELECT r.email, r.status FROM campaign_results r WHERE r.cid=?", c.Id) err = db.Model(&c).Related(&c.Results).Error
return c, err return c, err
} }
@ -58,7 +68,7 @@ func PostCampaign(c *Campaign, uid int64) error {
} }
} }
// Insert into the DB // Insert into the DB
err = Conn.Insert(c) err = db.Save(c).Error
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
return err return err
@ -67,35 +77,32 @@ func PostCampaign(c *Campaign, uid int64) error {
for _, g := range c.Groups { for _, g := range c.Groups {
// Insert a result for each target in the group // Insert a result for each target in the group
for _, t := range g.Targets { for _, t := range g.Targets {
r := Result{Target: t, Status: "Unknown"} r := Result{Email: t.Email, Status: "Unknown", CampaignId: c.Id}
c.Results = append(c.Results, r) c.Results = append(c.Results, r)
fmt.Printf("%v", c.Results) fmt.Printf("%v", c.Results)
_, err = Conn.Exec("INSERT INTO campaign_results VALUES (?,?,?)", c.Id, r.Email, r.Status) err := db.Save(&r).Error
if err != nil { if err != nil {
Logger.Printf("Error adding result record for target %s\n", t.Email) Logger.Printf("Error adding result record for target %s\n", t.Email)
Logger.Println(err) Logger.Println(err)
} }
} }
} }
_, err = Conn.Exec("INSERT OR IGNORE INTO user_campaigns VALUES (?,?)", uid, c.Id)
if err != nil {
Logger.Printf("Error adding many-many mapping for campaign %s\n", c.Name)
}
return nil return nil
} }
//DeleteCampaign deletes the specified campaign
func DeleteCampaign(id int64) error { func DeleteCampaign(id int64) error {
// Delete all the campaign_results entries for this group // Delete all the campaign results
_, err := Conn.Exec("DELETE FROM campaign_results WHERE cid=?", id) err := db.Delete(&Result{CampaignId: id}).Error
if err != nil { if err != nil {
Logger.Println(err)
return err return err
} }
// Delete the reference to the campaign in the user_campaigns table // Delete the campaign
_, err = Conn.Exec("DELETE FROM user_campaigns WHERE cid=?", id) err = db.Delete(&Campaign{Id: id}).Error
if err != nil { if err != nil {
Logger.Panicln(err)
return err return err
} }
// Delete the campaign itself
_, err = Conn.Exec("DELETE FROM campaigns WHERE id=?", id)
return err return err
} }

View File

@ -3,13 +3,21 @@ package models
import ( import (
"net/mail" "net/mail"
"time" "time"
"github.com/jinzhu/gorm"
) )
type Group struct { type Group struct {
Id int64 `json:"id"` Id int64 `json:"id"`
UserId int64 `json:"-"`
Name string `json:"name"` Name string `json:"name"`
ModifiedDate time.Time `json:"modified_date" db:"modified_date"` ModifiedDate time.Time `json:"modified_date"`
Targets []Target `json:"targets" db:"-"` Targets []Target `json:"targets" sql:"-"`
}
type GroupTarget struct {
GroupId int64 `json:"-"`
TargetId int64 `json:"-"`
} }
type Target struct { type Target struct {
@ -20,13 +28,13 @@ type Target struct {
// GetGroups returns the groups owned by the given user. // GetGroups returns the groups owned by the given user.
func GetGroups(uid int64) ([]Group, error) { func GetGroups(uid int64) ([]Group, error) {
gs := []Group{} gs := []Group{}
_, err := Conn.Select(&gs, "SELECT g.id, g.name, g.modified_date FROM groups g, user_groups ug, users u WHERE ug.uid=u.id AND ug.gid=g.id AND u.id=?", uid) err := db.Where("user_id=?", uid).Find(&gs).Error
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
return gs, err return gs, err
} }
for i, _ := range gs { for i, _ := range gs {
_, err := Conn.Select(&gs[i].Targets, "SELECT t.id, t.email FROM targets t, group_targets gt WHERE gt.gid=? AND gt.tid=t.id", gs[i].Id) gs[i].Targets, err = GetTargets(gs[i].Id)
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
} }
@ -37,12 +45,12 @@ func GetGroups(uid int64) ([]Group, error) {
// GetGroup returns the group, if it exists, specified by the given id and user_id. // GetGroup returns the group, if it exists, specified by the given id and user_id.
func GetGroup(id int64, uid int64) (Group, error) { func GetGroup(id int64, uid int64) (Group, error) {
g := Group{} g := Group{}
err := Conn.SelectOne(&g, "SELECT g.id, g.name, g.modified_date FROM groups g, user_groups ug, users u WHERE ug.uid=u.id AND ug.gid=g.id AND g.id=? AND u.id=?", id, uid) err := db.Where("user_id=? and id=?", uid, id).Find(&g).Error
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
return g, err return g, err
} }
_, err = Conn.Select(&g.Targets, "SELECT t.id, t.email FROM targets t, group_targets gt WHERE gt.gid=? AND gt.tid=t.id", g.Id) g.Targets, err = GetTargets(g.Id)
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
} }
@ -52,12 +60,12 @@ func GetGroup(id int64, uid int64) (Group, error) {
// GetGroupByName returns the group, if it exists, specified by the given name and user_id. // GetGroupByName returns the group, if it exists, specified by the given name and user_id.
func GetGroupByName(n string, uid int64) (Group, error) { func GetGroupByName(n string, uid int64) (Group, error) {
g := Group{} g := Group{}
err := Conn.SelectOne(&g, "SELECT g.id, g.name, g.modified_date FROM groups g, user_groups ug, users u WHERE ug.uid=u.id AND ug.gid=g.id AND g.name=? AND u.id=?", n, uid) err := db.Where("user_id=? and name=?", uid, n).Find(&g).Error
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
return g, err return g, err
} }
_, err = Conn.Select(&g.Targets, "SELECT t.id, t.email FROM targets t, group_targets gt WHERE gt.gid=? AND gt.tid=t.id", g.Id) g.Targets, err = GetTargets(g.Id)
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
} }
@ -65,18 +73,13 @@ func GetGroupByName(n string, uid int64) (Group, error) {
} }
// PostGroup creates a new group in the database. // PostGroup creates a new group in the database.
func PostGroup(g *Group, uid int64) error { func PostGroup(g *Group) error {
// Insert into the DB // Insert into the DB
err = Conn.Insert(g) err = db.Save(g).Error
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
return err return err
} }
// Now, let's add the user->user_groups->group mapping
_, err = Conn.Exec("INSERT OR IGNORE INTO user_groups VALUES (?,?)", uid, g.Id)
if err != nil {
Logger.Printf("Error adding many-many mapping for group %s\n", g.Name)
}
for _, t := range g.Targets { for _, t := range g.Targets {
insertTargetIntoGroup(t, g.Id) insertTargetIntoGroup(t, g.Id)
} }
@ -84,13 +87,9 @@ func PostGroup(g *Group, uid int64) error {
} }
// PutGroup updates the given group if found in the database. // PutGroup updates the given group if found in the database.
func PutGroup(g *Group, uid int64) error { func PutGroup(g *Group) error {
// Update all the foreign keys, and many to many relationships
// We will only delete the group->targets entries. We keep the actual targets
// since they are needed by the Results table
// Get all the targets currently in the database for the group
ts := []Target{} ts := []Target{}
_, err = Conn.Select(&ts, "SELECT t.id, t.email FROM targets t, group_targets gt WHERE gt.gid=? AND gt.tid=t.id", g.Id) ts, err = GetTargets(g.Id)
if err != nil { if err != nil {
Logger.Printf("Error getting targets from group ID: %d", g.Id) Logger.Printf("Error getting targets from group ID: %d", g.Id)
return err return err
@ -109,7 +108,7 @@ func PutGroup(g *Group, uid int64) error {
} }
// If the target does not exist in the group any longer, we delete it // If the target does not exist in the group any longer, we delete it
if !tExists { if !tExists {
_, err = Conn.Exec("DELETE FROM group_targets WHERE gid=? AND tid=?", g.Id, t.Id) err = db.Where("group_id=? and target_id=?", g.Id, t.Id).Delete(&GroupTarget{}).Error
if err != nil { if err != nil {
Logger.Printf("Error deleting email %s\n", t.Email) Logger.Printf("Error deleting email %s\n", t.Email)
} }
@ -131,9 +130,8 @@ func PutGroup(g *Group, uid int64) error {
insertTargetIntoGroup(nt, g.Id) insertTargetIntoGroup(nt, g.Id)
} }
} }
// Update the group err = db.Save(g).Error
g.ModifiedDate = time.Now() /*_, err = Conn.Update(g)*/
_, err = Conn.Update(g)
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
return err return err
@ -141,33 +139,47 @@ func PutGroup(g *Group, uid int64) error {
return nil return nil
} }
// DeleteGroup deletes a given group by group ID and user ID
func DeleteGroup(g *Group) error {
// Delete all the group_targets entries for this group
err := db.Where("group_id=?", g.Id).Delete(&GroupTarget{}).Error
if err != nil {
Logger.Println(err)
return err
}
// Delete the group itself
err = db.Delete(g).Error
if err != nil {
Logger.Println(err)
return err
}
return err
}
func insertTargetIntoGroup(t Target, gid int64) error { func insertTargetIntoGroup(t Target, gid int64) error {
if _, err = mail.ParseAddress(t.Email); err != nil { if _, err = mail.ParseAddress(t.Email); err != nil {
Logger.Printf("Invalid email %s\n", t.Email) Logger.Printf("Invalid email %s\n", t.Email)
return err return err
} }
trans, err := Conn.Begin() trans := db.Begin()
trans.Where(t).FirstOrCreate(&t)
if err != nil {
Logger.Printf("Error adding target: %s\n", t.Email)
return err
}
err = trans.Where("group_id=? and target_id=?", gid, t.Id).Find(&GroupTarget{}).Error
if err == gorm.RecordNotFound {
err = trans.Save(&GroupTarget{GroupId: gid, TargetId: t.Id}).Error
if err != nil { if err != nil {
Logger.Println(err) Logger.Println(err)
return err return err
} }
_, err = trans.Exec("INSERT OR IGNORE INTO targets VALUES (null, ?)", t.Email)
if err != nil {
Logger.Printf("Error adding email: %s\n", t.Email)
return err
} }
// Bug: res.LastInsertId() does not work for this, so we need to select it manually (how frustrating.)
t.Id, err = trans.SelectInt("SELECT id FROM targets WHERE email=?", t.Email)
if err != nil {
Logger.Printf("Error getting id for email: %s\n", t.Email)
return err
}
_, err = trans.Exec("INSERT OR IGNORE INTO group_targets VALUES (?,?)", gid, t.Id)
if err != nil { if err != nil {
Logger.Printf("Error adding many-many mapping for %s\n", t.Email) Logger.Printf("Error adding many-many mapping for %s\n", t.Email)
return err return err
} }
err = trans.Commit() err = trans.Commit().Error
if err != nil { if err != nil {
Logger.Printf("Error committing db changes\n") Logger.Printf("Error committing db changes\n")
return err return err
@ -175,19 +187,8 @@ func insertTargetIntoGroup(t Target, gid int64) error {
return nil return nil
} }
// DeleteGroup deletes a given group by group ID and user ID func GetTargets(gid int64) ([]Target, error) {
func DeleteGroup(id int64) error { ts := []Target{}
// Delete all the group_targets entries for this group err := db.Table("targets t").Select("t.id, t.email").Joins("left join group_targets gt ON t.id = gt.target_id").Where("gt.group_id=?", gid).Scan(&ts).Error
_, err := Conn.Exec("DELETE FROM group_targets WHERE gid=?", id) return ts, err
if err != nil {
return err
}
// Delete the reference to the group in the user_group table
_, err = Conn.Exec("DELETE FROM user_groups WHERE gid=?", id)
if err != nil {
return err
}
// Delete the group itself
_, err = Conn.Exec("DELETE FROM groups WHERE id=?", id)
return err
} }

View File

@ -1,74 +1,60 @@
package models package models
import ( import (
"database/sql"
"errors" "errors"
"log" "log"
"os" "os"
"github.com/coopernurse/gorp" "github.com/coopernurse/gorp"
"github.com/jinzhu/gorm"
"github.com/jordan-wright/gophish/config" "github.com/jordan-wright/gophish/config"
_ "github.com/mattn/go-sqlite3" _ "github.com/mattn/go-sqlite3"
) )
var Conn *gorp.DbMap var Conn *gorp.DbMap
var DB *sql.DB var db gorm.DB
var err error var err error
var ErrUsernameTaken = errors.New("Username already taken") var ErrUsernameTaken = errors.New("username already taken")
var Logger = log.New(os.Stdout, "", log.Ldate|log.Ltime|log.Lshortfile) var Logger = log.New(os.Stdout, " ", log.Ldate|log.Ltime|log.Lshortfile)
// Setup initializes the Conn object
// It also populates the Gophish Config object
func Setup() error {
DB, err := sql.Open("sqlite3", config.Conf.DBPath)
Conn = &gorp.DbMap{Db: DB, Dialect: gorp.SqliteDialect{}}
//If the file already exists, delete it and recreate it
_, err = os.Stat(config.Conf.DBPath)
Conn.AddTableWithName(User{}, "users").SetKeys(true, "Id")
Conn.AddTableWithName(Campaign{}, "campaigns").SetKeys(true, "Id")
Conn.AddTableWithName(Group{}, "groups").SetKeys(true, "Id")
Conn.AddTableWithName(Template{}, "templates").SetKeys(true, "Id")
if err != nil {
Logger.Println("Database not found, recreating...")
createTablesSQL := []string{
//Create tables
`CREATE TABLE users (id INTEGER PRIMARY KEY AUTOINCREMENT, username TEXT NOT NULL, hash VARCHAR(60) NOT NULL, api_key VARCHAR(32), UNIQUE(username), UNIQUE(api_key));`,
`CREATE TABLE campaigns (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, created_date TIMESTAMP NOT NULL, completed_date TIMESTAMP, template TEXT, status TEXT NOT NULL);`,
`CREATE TABLE targets (id INTEGER PRIMARY KEY AUTOINCREMENT, email TEXT NOT NULL, UNIQUE(email));`,
`CREATE TABLE groups (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, modified_date TIMESTAMP NOT NULL);`,
`CREATE TABLE campaign_results (cid INTEGER NOT NULL, email TEXT NOT NULL, status TEXT NOT NULL, FOREIGN KEY (cid) REFERENCES campaigns(id), UNIQUE(cid, email, status))`,
`CREATE TABLE templates (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, modified_date TIMESTAMP NOT NULL, html TEXT NOT NULL, text TEXT NOT NULL);`,
`CREATE TABLE files (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, path TEXT NOT NULL);`,
`CREATE TABLE user_campaigns (uid INTEGER NOT NULL, cid INTEGER NOT NULL, FOREIGN KEY (uid) REFERENCES users(id), FOREIGN KEY (cid) REFERENCES campaigns(id), UNIQUE(uid, cid))`,
`CREATE TABLE user_groups (uid INTEGER NOT NULL, gid INTEGER NOT NULL, FOREIGN KEY (uid) REFERENCES users(id), FOREIGN KEY (gid) REFERENCES groups(id), UNIQUE(uid, gid))`,
`CREATE TABLE group_targets (gid INTEGER NOT NULL, tid INTEGER NOT NULL, FOREIGN KEY (gid) REFERENCES groups(id), FOREIGN KEY (tid) REFERENCES targets(id), UNIQUE(gid, tid));`,
`CREATE TABLE user_templates (uid INTEGER NOT NULL, tid INTEGER NOT NULL, FOREIGN KEY (uid) REFERENCES users(id), FOREIGN KEY (tid) REFERENCES templates(id), UNIQUE(uid, tid));`,
`CREATE TABLE template_files (tid INTEGER NOT NULL, fid INTEGER NOT NULL, FOREIGN KEY (tid) REFERENCES templates(id), FOREIGN KEY(fid) REFERENCES files(id), UNIQUE(tid, fid));`,
}
Logger.Printf("Creating db at %s\n", config.Conf.DBPath)
//Create the tables needed
for _, stmt := range createTablesSQL {
_, err = DB.Exec(stmt)
if err != nil {
return err
}
}
//Create the default user
init_user := User{
Username: "admin",
Hash: "$2a$10$IYkPp0.QsM81lYYPrQx6W.U6oQGw7wMpozrKhKAHUBVL4mkm/EvAS", //gophish
APIKey: "12345678901234567890123456789012",
}
Conn.Insert(&init_user)
if err != nil {
Logger.Println(err)
}
}
return nil
}
// Flash is used to hold flash information for use in templates. // Flash is used to hold flash information for use in templates.
type Flash struct { type Flash struct {
Type string Type string
Message string Message string
} }
// Setup initializes the Conn object
// It also populates the Gophish Config object
func Setup() error {
db, err = gorm.Open("sqlite3", config.Conf.DBPath)
db.LogMode(true)
db.SetLogger(Logger)
if err != nil {
Logger.Println(err)
return err
}
//If the file already exists, delete it and recreate it
_, err = os.Stat(config.Conf.DBPath)
if err != nil {
Logger.Printf("Database not found... creating db at %s\n", config.Conf.DBPath)
db.CreateTable(User{})
db.CreateTable(Target{})
db.CreateTable(Result{})
db.CreateTable(Group{})
db.CreateTable(GroupTarget{})
db.CreateTable(Template{})
db.CreateTable(UserTemplate{})
db.CreateTable(Campaign{})
//Create the default user
init_user := User{
Username: "admin",
Hash: "$2a$10$IYkPp0.QsM81lYYPrQx6W.U6oQGw7wMpozrKhKAHUBVL4mkm/EvAS", //gophish
ApiKey: "12345678901234567890123456789012",
}
err = db.Save(&init_user).Error
if err != nil {
Logger.Println(err)
}
}
return nil
}

47
models/models_test.go Normal file
View File

@ -0,0 +1,47 @@
package models
import (
"os"
"testing"
"github.com/jordan-wright/gophish/config"
"launchpad.net/gocheck"
)
// Hook up gocheck into the "go test" runner.
func Test(t *testing.T) { gocheck.TestingT(t) }
type ModelsSuite struct{}
var _ = gocheck.Suite(&ModelsSuite{})
func (s *ModelsSuite) SetUpSuite(c *gocheck.C) {
config.Conf.DBPath = "../gophish_test.db"
err := Setup()
if err != nil {
c.Fatalf("Failed creating database: %v", err)
}
}
func (s *ModelsSuite) TestGetUser(c *gocheck.C) {
u, err := GetUser(1)
c.Assert(err, gocheck.Equals, nil)
c.Assert(u.Username, gocheck.Equals, "admin")
}
func (s *ModelsSuite) TestPutUser(c *gocheck.C) {
u, err := GetUser(1)
u.Username = "admin_changed"
err = PutUser(&u)
c.Assert(err, gocheck.Equals, nil)
u, err = GetUser(1)
c.Assert(u.Username, gocheck.Equals, "admin_changed")
}
func (s *ModelsSuite) TearDownSuite(c *gocheck.C) {
db.DB().Close()
err := os.Remove(config.Conf.DBPath)
if err != nil {
c.Fatalf("Failed deleting test database: %v", err)
}
}

View File

@ -4,39 +4,40 @@ import "time"
type Template struct { type Template struct {
Id int64 `json:"id"` Id int64 `json:"id"`
Name string `json:"name" db:"name"` Name string `json:"name"`
Text string `json:"text" db:"text"` Text string `json:"text"`
Html string `json:"html" db:"html"` Html string `json:"html"`
ModifiedDate time.Time `json:"modified_date" db:"modified_date"` ModifiedDate time.Time `json:"modified_date"`
}
type UserTemplate struct {
UserId int64 `json:"-"`
TemplateId int64 `json:"-"`
} }
// GetTemplates returns the templates owned by the given user. // GetTemplates returns the templates owned by the given user.
func GetTemplates(uid int64) ([]Template, error) { func GetTemplates(uid int64) ([]Template, error) {
ts := []Template{} ts := []Template{}
_, err := Conn.Select(&ts, "SELECT t.id, t.name, t.modified_date, t.text, t.html FROM templates t, user_templates ut, users u WHERE ut.uid=u.id AND ut.tid=t.id AND u.id=?", uid) err := db.Table("templates t").Select("t.*").Joins("left join user_templates ut ON t.id = ut.template_id").Where("ut.user_id=?", uid).Scan(&ts).Error
return ts, err return ts, err
} }
// GetTemplate returns the template, if it exists, specified by the given id and user_id. // GetTemplate returns the template, if it exists, specified by the given id and user_id.
func GetTemplate(id int64, uid int64) (Template, error) { func GetTemplate(id int64, uid int64) (Template, error) {
t := Template{} t := Template{}
err := Conn.SelectOne(&t, "SELECT t.id, t.name, t.modified_date, t.text, t.html FROM templates t, user_templates ut, users u WHERE ut.uid=u.id AND ut.tid=t.id AND t.id=? AND u.id=?", id, uid) err := db.Table("templates t").Select("t.*").Joins("left join user_templates ut ON t.id = ut.template_id").Where("ut.user_id=? and t.id=?", uid, id).Scan(&t).Error
if err != nil {
return t, err
}
return t, err return t, err
} }
// PostTemplate creates a new template in the database. // PostTemplate creates a new template in the database.
func PostTemplate(t *Template, uid int64) error { func PostTemplate(t *Template, uid int64) error {
// Insert into the DB // Insert into the DB
err = Conn.Insert(t) err := db.Save(t).Error
if err != nil { if err != nil {
Logger.Println(err)
return err return err
} }
// Now, let's add the user->user_templates->template mapping // Now, let's add the user->user_templates->template mapping
_, err = Conn.Exec("INSERT OR IGNORE INTO user_templates VALUES (?,?)", uid, t.Id) err = db.Exec("INSERT OR IGNORE INTO user_templates VALUES (?,?)", uid, t.Id).Error
if err != nil { if err != nil {
Logger.Printf("Error adding many-many mapping for template %s\n", t.Name) Logger.Printf("Error adding many-many mapping for template %s\n", t.Name)
} }

View File

@ -5,16 +5,16 @@ import "database/sql"
// User represents the user model for gophish. // User represents the user model for gophish.
type User struct { type User struct {
Id int64 `json:"id"` Id int64 `json:"id"`
Username string `json:"username"` Username string `json:"username" sql:"not null;unique"`
Hash string `json:"-"` Hash string `json:"-"`
APIKey string `json:"api_key" db:"api_key"` ApiKey string `json:"api_key" sql:"not null;unique"`
} }
// GetUser returns the user that the given id corresponds to. If no user is found, an // GetUser returns the user that the given id corresponds to. If no user is found, an
// error is thrown. // error is thrown.
func GetUser(id int64) (User, error) { func GetUser(id int64) (User, error) {
u := User{} u := User{}
err := Conn.SelectOne(&u, "SELECT * FROM Users WHERE id=?", id) err := db.Where("id=?", id).First(&u).Error
if err != nil { if err != nil {
return u, err return u, err
} }
@ -23,9 +23,9 @@ func GetUser(id int64) (User, error) {
// GetUserByAPIKey returns the user that the given API Key corresponds to. If no user is found, an // GetUserByAPIKey returns the user that the given API Key corresponds to. If no user is found, an
// error is thrown. // error is thrown.
func GetUserByAPIKey(key []byte) (User, error) { func GetUserByAPIKey(key string) (User, error) {
u := User{} u := User{}
err := Conn.SelectOne(&u, "SELECT id, username, api_key FROM Users WHERE apikey=?", key) err := db.Where("api_key = ?", key).First(&u).Error
if err != nil { if err != nil {
return u, err return u, err
} }
@ -36,7 +36,7 @@ func GetUserByAPIKey(key []byte) (User, error) {
// error is thrown. // error is thrown.
func GetUserByUsername(username string) (User, error) { func GetUserByUsername(username string) (User, error) {
u := User{} u := User{}
err := Conn.SelectOne(&u, "SELECT * FROM Users WHERE username=?", username) err := db.Where("username = ?", username).First(&u).Error
if err != sql.ErrNoRows { if err != sql.ErrNoRows {
return u, ErrUsernameTaken return u, ErrUsernameTaken
} else if err != nil { } else if err != nil {
@ -47,6 +47,6 @@ func GetUserByUsername(username string) (User, error) {
// PutUser updates the given user // PutUser updates the given user
func PutUser(u *User) error { func PutUser(u *User) error {
_, err := Conn.Update(u) err := db.Save(u).Error
return err return err
} }

View File

@ -20,7 +20,7 @@
<link href="/css/font-awesome.min.css" rel="stylesheet"> <link href="/css/font-awesome.min.css" rel="stylesheet">
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,300,600,700' rel='stylesheet' type='text/css'> <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,300,600,700' rel='stylesheet' type='text/css'>
{{%if .User%}} {{%if .User%}}
<script>var API_KEY = {{%.User.APIKey%}}</script> <script>var API_KEY = {{%.User.ApiKey%}}</script>
{{%end%}} {{%end%}}
</head> </head>

View File

@ -27,7 +27,7 @@
<div class="row"> <div class="row">
<label for="api_key" class="col-sm-2 control-label form-label">API Key:</label> <label for="api_key" class="col-sm-2 control-label form-label">API Key:</label>
<div class="col-md-6"> <div class="col-md-6">
<input type="text" id="api_key" onclick="this.select();" value="{{%.User.APIKey%}}" class="form-control" readonly/> <input type="text" id="api_key" onclick="this.select();" value="{{%.User.ApiKey%}}" class="form-control" readonly/>
</div> </div>
<form action="/api/reset" method="POST"> <form action="/api/reset" method="POST">
<button class="btn btn-primary"><i class="fa fa-refresh" type="submit"></i> Reset</button> <button class="btn btn-primary"><i class="fa fa-refresh" type="submit"></i> Reset</button>